main_ticker.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, a command-line cryptocurrency wallet
  4. # Copyright (C)2013-2022 The MMGen Project <mmgen@tuta.io>
  5. # Licensed under the GNU General Public License, Version 3:
  6. # https://www.gnu.org/licenses
  7. # Public project repositories:
  8. # https://github.com/mmgen/mmgen-wallet https://github.com/mmgen/mmgen-node-tools
  9. # https://gitlab.com/mmgen/mmgen-wallet https://gitlab.com/mmgen/mmgen-node-tools
  10. """
  11. mmnode-ticker: Display price information for cryptocurrency and other assets
  12. """
  13. opts_data = {
  14. 'sets': [
  15. ('widest', True, 'percent_cols', 'd,w,m,y'),
  16. ('widest', True, 'name_labels', True),
  17. ('widest', True, 'thousands_comma', True),
  18. ('widest', True, 'update_time', True),
  19. ('wide', True, 'percent_cols', 'd,w'),
  20. ('wide', True, 'name_labels', True),
  21. ('wide', True, 'thousands_comma', True),
  22. ('wide', True, 'update_time', True),
  23. ],
  24. 'text': {
  25. 'desc': 'Display prices for cryptocurrency and other assets',
  26. 'usage': '[opts] [TRADE_SPECIFIER]',
  27. 'options': """
  28. -h, --help Print this help message
  29. --, --longhelp Print help message for long options (common options)
  30. -a, --asset-limit=N Retrieve data for top ‘N’ cryptocurrencies by market
  31. cap (default: {al}). To retrieve all available data,
  32. specify a value of zero.
  33. -A, --adjust=P Adjust prices by percentage ‘P’. In ‘trading’ mode,
  34. spot and adjusted prices are shown in separate columns.
  35. -b, --btc Fetch and display data for Bitcoin only
  36. -c, --add-columns=LIST Add columns for asset specifiers in LIST (comma-
  37. separated, see ASSET SPECIFIERS below). Can also be
  38. used to supply a USD exchange rate for missing assets.
  39. -C, --cached-data Use cached data from previous network query instead of
  40. live data from server
  41. -D, --cachedir=D Read and write cached JSON data to directory ‘D’
  42. instead of ‘~/{dfl_cachedir}’
  43. -d, --download=D Retrieve and cache asset data ‘D’ from network (valid
  44. options: {ds})
  45. -e, --add-precision=N Add ‘N’ digits of precision to columns
  46. -E, --elapsed Show elapsed time in UPDATED column (see --update-time)
  47. -F, --portfolio Display portfolio data
  48. -l, --list-ids List IDs of all available assets
  49. -n, --name-labels Label rows with asset names rather than symbols
  50. -p, --percent-cols=C Add daily, weekly, monthly, or yearly percentage change
  51. columns ‘C’ (specify with comma-separated letters
  52. {pc})
  53. -P, --pager Pipe the output to a pager
  54. -q, --quiet Produce quieter output
  55. -r, --add-rows=LIST Add rows for asset specifiers in LIST (comma-separated,
  56. see ASSET SPECIFIERS below). Can also be used to supply
  57. a USD exchange rate for missing assets.
  58. -t, --testing Print command(s) to be executed to stdout and exit
  59. -T, --thousands-comma Use comma as a thousands separator
  60. -u, --update-time Include UPDATED (last update time) column
  61. -v, --verbose Be more verbose
  62. -w, --wide Display most optional columns (same as -unT -p d,w)
  63. -W, --widest Display all optional columns (same as -unT -p d,w,m,y)
  64. -x, --proxy=P Connect via proxy ‘P’. Set to the empty string to
  65. completely disable or ‘none’ to allow override from
  66. environment. Consult the curl manpage for --proxy usage.
  67. -X, --proxy2=P Alternate proxy for non-crypto financial data. Defaults
  68. to value of --proxy
  69. """,
  70. 'notes': """
  71. The script has two display modes: ‘overview’, the default, and ‘trading’, the
  72. latter being enabled when a TRADE_SPECIFIER argument (see below) is supplied
  73. on the command line.
  74. Overview mode displays prices of all configured assets, and optionally the
  75. user’s portfolio, while trading mode displays the price of a given quantity
  76. of an asset in relation to other assets, optionally comparing an offered
  77. price to the spot price.
  78. ASSETS consist of either a symbol (e.g. ‘xmr’) or full ID (see --list-ids)
  79. consisting of symbol plus label (e.g. ‘xmr-monero’). In cases where the
  80. symbol is ambiguous, the full ID must be used. For Yahoo Finance assets
  81. the symbol and ID are identical:
  82. Examples:
  83. ltc - specify asset by symbol
  84. ltc-litecoin - same as above, but use full ID instead of symbol
  85. ^dji - Dow Jones Industrial Average (Yahoo)
  86. gc=f - gold futures (Yahoo)
  87. ASSET SPECIFIERS have the following format:
  88. ASSET[:RATE[:RATE_ASSET]]
  89. If the asset referred to by ASSET is not in the source data (see --list-ids),
  90. an arbitrarily chosen label may be used. RATE is the exchange rate of the
  91. asset in relation to RATE_ASSET, if present, otherwise USD. When RATE is
  92. postfixed with the letter ‘r’, its meaning is reversed, i.e. interpreted as
  93. ‘ASSET/RATE_ASSET’ instead of ‘RATE_ASSET/ASSET’. Asset specifier examples:
  94. inr:79.5 - INR is not in the source data, so supply rate of
  95. 79.5 INR to the Dollar (USD/INR)
  96. inr:0.01257r - same as above, but use reverse rate (INR/USD)
  97. inr-indian-rupee:79.5 - same as first example, but add an arbitrary label
  98. omr-omani-rial:2.59r - Omani Rial is pegged to the Dollar at 2.59 USD
  99. bgn-bulgarian-lev:0.5113r:eurusd=x
  100. - Bulgarian Lev is pegged to the Euro at 0.5113 EUR
  101. A TRADE_SPECIFIER is a single argument in the format:
  102. ASSET:AMOUNT[:TO_ASSET[:TO_AMOUNT]]
  103. Examples:
  104. xmr:17.34 - price of 17.34 XMR in all configured assets
  105. xmr-monero:17.34 - same as above, but with full ID
  106. xmr:17.34:eurusd=x - price of 17.34 XMR in EUR only
  107. xmr:17.34:eurusd=x:2800 - commission on an offer of 17.34 XMR for 2800 EUR
  108. TO_AMOUNT, if included, is used to calculate the percentage difference or
  109. commission on an offer compared to the spot price.
  110. If either ASSET or TO_ASSET refer to assets not present in the source data,
  111. a USD rate for the missing asset(s) must be supplied via the --add-columns
  112. or --add-rows options.
  113. PROXY NOTE
  114. The remote server used to obtain the crypto price data, {cc.api_host},
  115. blocks Tor behind a Captcha wall, so a Tor proxy cannot be used directly.
  116. If you’re concerned about privacy, connect via a VPN, or better yet, VPN over
  117. Tor. Then set up an HTTP proxy (e.g. Privoxy) on the VPN’ed host and set the
  118. ‘proxy’ option in the config file or --proxy on the command line accordingly.
  119. Or run the script directly on the VPN’ed host with ’proxy’ or --proxy set to
  120. the null string.
  121. Alternatively, you may download the JSON source data in a Tor-proxied browser
  122. from {cc.api_url}, save it as ‘ticker.json’ in your
  123. configured cache directory and run the script with the --cached-data option.
  124. Financial data is obtained from {fi.desc}, which currently allows Tor.
  125. RATE LIMITING NOTE
  126. To protect user privacy, filtering and processing of cryptocurrency data is
  127. performed client side so that the remote server does not know which assets
  128. are being examined. This is done by fetching data for the top {al} crypto
  129. assets by market cap (configurable via the --asset-limit option) with each
  130. invocation of the script. A rate limit of {cc.ratelimit} seconds between calls is thus
  131. imposed to prevent abuse of the remote server. When the --btc option is in
  132. effect, this limit is reduced to {cc.btc_ratelimit} seconds. To bypass the rate limit
  133. entirely, use --cached-data.
  134. Note that financial data obtained from {fi.api_host} is filtered in the
  135. request, which has privacy implications. The rate limit for financial data
  136. is {fi.ratelimit} seconds.
  137. EXAMPLES
  138. # Basic display in ‘overview’ mode:
  139. $ mmnode-ticker
  140. # Display BTC price only:
  141. $ mmnode-ticker --btc
  142. # Wide display, add EUR and OMR columns, OMR/USD rate, extra precision and
  143. # proxy:
  144. $ mmnode-ticker -w -c eurusd=x,omr-omani-rial:2.59r -e2 -x http://vpnhost:8118
  145. # Wide display, elapsed update time, add EUR, BGN columns and BGN/EUR rate:
  146. $ mmnode-ticker -wE -c eurusd=x,bgn-bulgarian-lev:0.5113r:eurusd=x
  147. # Widest display with all percentage change columns, use cached data from
  148. # previous network query, show portfolio (see above), pipe output to pager,
  149. # add DOGE row:
  150. $ mmnode-ticker -WCFP -r doge
  151. # Display 17.234 XMR priced in all configured assets (‘trading’ mode):
  152. $ mmnode-ticker xmr:17.234
  153. # Same as above, but add INR price at specified USDINR rate:
  154. $ mmnode-ticker -c inr:79.5 xmr:17.234
  155. # Same as above, but view INR price only at specified rate, adding label:
  156. $ mmnode-ticker -c inr-indian-rupee:79.5 xmr:17.234:inr
  157. # Calculate commission on an offer of 2700 USD for 0.123 BTC, compared to
  158. # current spot price:
  159. $ mmnode-ticker usd:2700:btc:0.123
  160. # Calculate commission on an offer of 200000 INR for 0.1 BTC, compared to
  161. # current spot price, at specified USDINR rate:
  162. $ mmnode-ticker -n -c inr-indian-rupee:79.5 inr:200000:btc:0.1
  163. CONFIGURED ASSETS:
  164. {assets}
  165. Customize output by editing the file
  166. ~/{cfg}
  167. To add a portfolio, edit the file
  168. ~/{pf_cfg}
  169. """
  170. },
  171. 'code': {
  172. 'options': lambda s: s.format(
  173. dfl_cachedir = os.path.relpath(dfl_cachedir,start=homedir),
  174. ds = fmt_dict(DataSource.get_sources(),fmt='equal_compact'),
  175. al = DataSource.coinpaprika.dfl_asset_limit,
  176. pc = fmt_list(Ticker.percent_cols,fmt='bare'),
  177. ),
  178. 'notes': lambda s: s.format(
  179. assets = fmt_list(assets_list_gen(cfg_in),fmt='col',indent=' '),
  180. cfg = os.path.relpath(cfg_in.cfg_file,start=homedir),
  181. pf_cfg = os.path.relpath(cfg_in.portfolio_file,start=homedir),
  182. al = DataSource.coinpaprika.dfl_asset_limit,
  183. cc = src_cls['cc'](),
  184. fi = src_cls['fi'](),
  185. )
  186. }
  187. }
  188. import os
  189. from mmgen.util import fmt_list,fmt_dict
  190. from mmgen.cfg import Config
  191. from . import Ticker
  192. gcfg = Config( opts_data=opts_data, do_post_init=True )
  193. Ticker.make_cfg(gcfg)
  194. from .Ticker import dfl_cachedir,homedir,DataSource,assets_list_gen,cfg_in,src_cls
  195. gcfg._post_init()
  196. Ticker.main()