Ticker.py 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137
  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. mmgen_node_tools.Ticker: Display price information for cryptocurrency and other assets
  12. """
  13. # v3.2.dev4: switch to new coinpaprika ‘tickers’ API call (supports ‘limit’ parameter, more historical data)
  14. # Old ‘ticker’ API (/v1/ticker): data['BTC']['price_usd']
  15. # New ‘tickers’ API (/v1/tickers): data['BTC']['quotes']['USD']['price']
  16. # Possible alternatives:
  17. # - https://min-api.cryptocompare.com/data/pricemultifull?fsyms=BTC,LTC&tsyms=USD,EUR
  18. import sys,os,re,time,datetime,json,yaml,random
  19. from subprocess import run,PIPE,CalledProcessError
  20. from decimal import Decimal
  21. from collections import namedtuple
  22. from mmgen.color import red,yellow,green,blue,orange,gray
  23. from mmgen.util import msg,msg_r,Msg,Msg_r,die,Die,suf,fmt,fmt_list,fmt_dict,list_gen
  24. from mmgen.ui import do_pager
  25. homedir = os.getenv('HOME')
  26. dfl_cachedir = os.path.join(homedir,'.cache','mmgen-node-tools')
  27. cfg_fn = 'ticker-cfg.yaml'
  28. portfolio_fn = 'ticker-portfolio.yaml'
  29. asset_tuple = namedtuple('asset_tuple',['symbol','id','source'])
  30. last_api_host = None
  31. percent_cols = {
  32. 'd': 'day',
  33. 'w': 'week',
  34. 'm': 'month',
  35. 'y': 'year',
  36. }
  37. class DataSource:
  38. source_groups = [
  39. {
  40. 'cc': 'coinpaprika'
  41. }, {
  42. 'fi': 'yahoospot',
  43. 'hi': 'yahoohist',
  44. }
  45. ]
  46. @classmethod
  47. def get_sources(cls,randomize=False):
  48. g = random.sample(cls.source_groups,k=len(cls.source_groups)) if randomize else cls.source_groups
  49. return {k:v for a in g for k,v in a.items()}
  50. class base:
  51. def fetch_delay(self):
  52. global last_api_host
  53. if not gcfg.testing and last_api_host and last_api_host != self.api_host:
  54. delay = 1 + random.randrange(1,5000) / 1000
  55. msg_r(f'Waiting {delay:.3f} seconds...')
  56. time.sleep(delay)
  57. msg('')
  58. last_api_host = self.api_host
  59. def get_data_from_network(self):
  60. curl_cmd = list_gen(
  61. ['curl', '--tr-encoding', '--header', 'Accept: application/json',True],
  62. ['--compressed'], # adds 'Accept-Encoding: gzip'
  63. ['--proxy', cfg.proxy, isinstance(cfg.proxy,str)],
  64. ['--silent', not cfg.verbose],
  65. [self.api_url]
  66. )
  67. if gcfg.testing:
  68. Msg(fmt_list(curl_cmd,fmt='bare'))
  69. return
  70. try:
  71. return run(curl_cmd,check=True,stdout=PIPE).stdout.decode()
  72. except CalledProcessError as e:
  73. msg('')
  74. from .Misc import curl_exit_codes
  75. msg(red(curl_exit_codes[e.returncode]))
  76. msg(red('Command line:\n {}'.format( ' '.join((repr(i) if ' ' in i else i) for i in e.cmd) )))
  77. from mmgen.exception import MMGenCalledProcessError
  78. raise MMGenCalledProcessError(f'Subprocess returned non-zero exit status {e.returncode}')
  79. def get_data(self):
  80. if not os.path.exists(cfg.cachedir):
  81. os.makedirs(cfg.cachedir)
  82. if not os.path.exists(self.json_fn):
  83. open(self.json_fn,'w').write('{}')
  84. use_cached_data = cfg.cached_data and not gcfg.download
  85. if use_cached_data:
  86. data_type = 'json'
  87. data_in = open(self.json_fn).read()
  88. else:
  89. data_type = self.net_data_type
  90. elapsed = int(time.time() - os.stat(self.json_fn).st_mtime)
  91. if elapsed >= self.timeout or gcfg.testing:
  92. if gcfg.testing:
  93. msg('')
  94. self.fetch_delay()
  95. msg_r(f'Fetching {self.data_desc} from {self.api_host}...')
  96. if self.has_verbose and cfg.verbose:
  97. msg('')
  98. data_in = self.get_data_from_network()
  99. msg('done')
  100. if gcfg.testing:
  101. return {}
  102. else:
  103. die(1,self.rate_limit_errmsg(elapsed))
  104. if data_type == 'json':
  105. try:
  106. data = json.loads(data_in)
  107. except:
  108. self.json_data_error_msg(data_in)
  109. die(2,'Retrieved data is not valid JSON, exiting')
  110. json_text = data_in
  111. elif data_type == 'python':
  112. data = data_in
  113. json_text = json.dumps(data_in)
  114. if not data:
  115. if use_cached_data:
  116. die(1,
  117. f'No cached {self.data_desc}! Run command without the --cached-data option, '
  118. 'or use --download to retrieve data from remote host')
  119. else:
  120. die(2,'Remote host returned no data!')
  121. elif 'error' in data:
  122. die(1,data['error'])
  123. if use_cached_data:
  124. if not cfg.quiet:
  125. msg(f'Using cached data from ~/{self.json_fn_rel}')
  126. else:
  127. if os.path.exists(self.json_fn):
  128. os.rename(self.json_fn, self.json_fn + '.bak')
  129. with open(self.json_fn, 'w') as fh:
  130. fh.write(json_text)
  131. if not cfg.quiet:
  132. msg(f'JSON data cached to ~/{self.json_fn_rel}')
  133. if gcfg.download:
  134. sys.exit(0)
  135. return self.postprocess_data(data)
  136. def json_data_error_msg(self,json_text):
  137. pass
  138. def postprocess_data(self,data):
  139. return data
  140. @property
  141. def json_fn_rel(self):
  142. return os.path.relpath(self.json_fn,start=homedir)
  143. class coinpaprika(base):
  144. desc = 'CoinPaprika'
  145. data_desc = 'cryptocurrency data'
  146. api_host = 'api.coinpaprika.com'
  147. ratelimit = 240
  148. btc_ratelimit = 10
  149. net_data_type = 'json'
  150. has_verbose = True
  151. dfl_asset_limit = 2000
  152. def __init__(self):
  153. self.asset_limit = int(cfg.asset_limit or self.dfl_asset_limit)
  154. def rate_limit_errmsg(self,elapsed):
  155. return (
  156. f'Rate limit exceeded! Retry in {self.timeout-elapsed} seconds' +
  157. ('' if cfg.btc_only else ', or use --cached-data or --btc')
  158. )
  159. @property
  160. def api_url(self):
  161. return (
  162. f'https://{self.api_host}/v1/tickers/btc-bitcoin' if cfg.btc_only else
  163. f'https://{self.api_host}/v1/tickers?limit={self.asset_limit}' if self.asset_limit else
  164. f'https://{self.api_host}/v1/tickers' )
  165. @property
  166. def json_fn(self):
  167. return os.path.join(
  168. cfg.cachedir,
  169. 'ticker-btc.json' if cfg.btc_only else 'ticker.json' )
  170. @property
  171. def timeout(self):
  172. return 0 if gcfg.test_suite else self.btc_ratelimit if cfg.btc_only else self.ratelimit
  173. def json_data_error_msg(self,json_text):
  174. tor_captcha_msg = f"""
  175. If you’re using Tor, the API request may have failed due to Captcha protection.
  176. A workaround for this issue is to retrieve the JSON data with a browser from
  177. the following URL:
  178. {self.api_url}
  179. and save it to:
  180. ‘{cfg.cachedir}/ticker.json’
  181. Then invoke the program with --cached-data and without --btc
  182. """
  183. msg(json_text[:1024] + '...')
  184. msg(orange(fmt(tor_captcha_msg,strip_char='\t')))
  185. def postprocess_data(self,data):
  186. return [data] if cfg.btc_only else data
  187. @staticmethod
  188. def parse_asset_id(s,require_label):
  189. sym,label = (*s.split('-',1),None)[:2]
  190. if require_label and not label:
  191. die(1,f'{s!r}: asset label is missing')
  192. return asset_tuple(
  193. symbol = sym.upper(),
  194. id = (s.lower() if label else None),
  195. source = 'cc' )
  196. class yahoospot(base):
  197. desc = 'Yahoo Finance'
  198. data_desc = 'spot financial data'
  199. api_host = 'finance.yahoo.com'
  200. ratelimit = 30
  201. net_data_type = 'python'
  202. has_verbose = False
  203. asset_id_pat = r'^\^.*|.*=[xf]$'
  204. json_fn_basename = 'ticker-finance.json'
  205. @staticmethod
  206. def get_id(sym,data):
  207. return sym.lower()
  208. @staticmethod
  209. def conv_data(sym,data,btcusd):
  210. price_usd = Decimal( data['regularMarketPrice']['raw'] )
  211. return {
  212. 'id': sym,
  213. 'name': data['shortName'],
  214. 'symbol': sym.upper(),
  215. 'price_usd': price_usd,
  216. 'price_btc': price_usd / btcusd,
  217. 'percent_change_1y': data['pct_chg_1y'],
  218. 'percent_change_30d': data['pct_chg_4wks'],
  219. 'percent_change_7d': data['pct_chg_1wk'],
  220. 'percent_change_24h': data['regularMarketChangePercent']['raw'] * 100,
  221. 'last_updated': data['regularMarketTime'],
  222. }
  223. def rate_limit_errmsg(self,elapsed):
  224. return f'Rate limit exceeded! Retry in {self.timeout-elapsed} seconds, or use --cached-data'
  225. @property
  226. def json_fn(self):
  227. return os.path.join( cfg.cachedir, self.json_fn_basename )
  228. @property
  229. def timeout(self):
  230. return 0 if gcfg.test_suite else self.ratelimit
  231. @property
  232. def symbols(self):
  233. return [r.symbol for r in cfg.rows if isinstance(r,tuple) and r.source == 'fi']
  234. def get_data_from_network(self):
  235. kwargs = {
  236. 'formatted': True,
  237. 'asynchronous': True,
  238. 'proxies': { 'https': cfg.proxy2 },
  239. }
  240. if gcfg.test_suite:
  241. kwargs.update({ 'timeout': 1, 'retry': 0 })
  242. if gcfg.testing:
  243. Msg('\nyahooquery.Ticker(\n {},\n {}\n)'.format(
  244. self.symbols,
  245. fmt_dict(kwargs,fmt='kwargs') ))
  246. return
  247. from yahooquery import Ticker
  248. return self.process_network_data( Ticker(self.symbols,**kwargs) )
  249. def process_network_data(self,ticker):
  250. return ticker.price
  251. @staticmethod
  252. def parse_asset_id(s,require_label):
  253. return asset_tuple(
  254. symbol = s.upper(),
  255. id = s.lower(),
  256. source = 'fi' )
  257. class yahoohist(yahoospot):
  258. json_fn_basename = 'ticker-finance-history.json'
  259. data_desc = 'historical financial data'
  260. net_data_type = 'json'
  261. period = '1y'
  262. interval = '1wk'
  263. def process_network_data(self,ticker):
  264. return ticker.history(
  265. period = self.period,
  266. interval = self.interval).to_json(orient='index')
  267. def postprocess_data(self,data):
  268. def gen():
  269. keys = set()
  270. for key,val in data.items():
  271. if m := re.match(r"\('(.*?)', datetime\.date\((.*)\)\)$",key):
  272. date = '{}-{:>02}-{:>02}'.format(*m[2].split(', '))
  273. if (sym := m[1]) in keys:
  274. d[date] = val
  275. else:
  276. keys.add(sym)
  277. d = {date:val}
  278. yield (sym,d)
  279. return dict(gen())
  280. def assets_list_gen(cfg_in):
  281. for k,v in cfg_in.cfg['assets'].items():
  282. yield ''
  283. yield k.upper()
  284. for e in v:
  285. out = e.split('-',1)
  286. yield ' {:5s} {}'.format(out[0],out[1] if len(out) == 2 else '')
  287. def gen_data(data):
  288. """
  289. Filter the raw data and return it as a dict keyed by the IDs of the assets
  290. we want to display.
  291. Add dummy entry for USD and entry for user-specified asset, if any.
  292. Since symbols in source data are not guaranteed to be unique (e.g. XAG), we
  293. must search the data twice: first for unique IDs, then for symbols while
  294. checking for duplicates.
  295. """
  296. def dup_sym_errmsg(dup_sym):
  297. return (
  298. f'The symbol {dup_sym!r} is shared by the following assets:\n' +
  299. '\n ' + '\n '.join(d['id'] for d in data['cc'] if d['symbol'] == dup_sym) +
  300. '\n\nPlease specify the asset by one of the full IDs listed above\n' +
  301. f'instead of {dup_sym!r}'
  302. )
  303. def check_assets_found(wants,found,keys=['symbol','id']):
  304. error = False
  305. for k in keys:
  306. missing = wants[k] - found[k]
  307. if missing:
  308. msg(
  309. ('The following IDs were not found in source data:\n{}' if k == 'id' else
  310. 'The following symbols could not be resolved:\n{}').format(
  311. fmt_list(missing,fmt='col',indent=' ')
  312. ))
  313. error = True
  314. if error:
  315. die(1,'Missing data, exiting')
  316. rows_want = {
  317. 'id': {r.id for r in cfg.rows if isinstance(r,tuple) and r.id} - {'usd-us-dollar'},
  318. 'symbol': {r.symbol for r in cfg.rows if isinstance(r,tuple) and r.id is None} - {'USD'},
  319. }
  320. usr_rate_assets = tuple(u.rate_asset for u in cfg.usr_rows + cfg.usr_columns if u.rate_asset)
  321. usr_rate_assets_want = {
  322. 'id': {a.id for a in usr_rate_assets if a.id},
  323. 'symbol': {a.symbol for a in usr_rate_assets if not a.id}
  324. }
  325. usr_assets = cfg.usr_rows + cfg.usr_columns + tuple(c for c in (cfg.query or ()) if c)
  326. usr_wants = {
  327. 'id': (
  328. {a.id for a in usr_assets + usr_rate_assets if a.id} -
  329. {a.id for a in usr_assets if a.rate and a.id} - {'usd-us-dollar'} )
  330. ,
  331. 'symbol': (
  332. {a.symbol for a in usr_assets + usr_rate_assets if not a.id} -
  333. {a.symbol for a in usr_assets if a.rate} - {'USD'} ),
  334. }
  335. found = { 'id': set(), 'symbol': set() }
  336. rate_assets = {}
  337. wants = {k:rows_want[k] | usr_wants[k] for k in ('id','symbol')}
  338. for d in data['cc']:
  339. if d['id'] == 'btc-bitcoin':
  340. btcusd = Decimal(str(d['quotes']['USD']['price']))
  341. break
  342. get_id = src_cls['fi'].get_id
  343. conv_func = src_cls['fi'].conv_data
  344. for k,v in data['fi'].items():
  345. id = get_id(k,v)
  346. if wants['id']:
  347. if id in wants['id']:
  348. if not isinstance(v,dict):
  349. die(2, str(v))
  350. if id in found['id']:
  351. die(1,dup_sym_errmsg(id))
  352. if m := data['hi'].get(k):
  353. spot = v['regularMarketPrice']['raw']
  354. hist = tuple(m.values())
  355. v['pct_chg_1wk'], v['pct_chg_4wks'], v['pct_chg_1y'] = (
  356. (spot / hist[-2]['close'] - 1) * 100,
  357. (spot / hist[-5]['close'] - 1) * 100, # 4 weeks ≈ 1 month
  358. (spot / hist[0]['close'] - 1) * 100,
  359. )
  360. else:
  361. v['pct_chg_1wk'] = v['pct_chg_4wks'] = v['pct_chg_1y'] = None
  362. yield ( id, conv_func(id,v,btcusd) )
  363. found['id'].add(id)
  364. wants['id'].remove(id)
  365. if id in usr_rate_assets_want['id']:
  366. rate_assets[k] = conv_func(id,v,btcusd) # NB: using symbol instead of ID for key
  367. else:
  368. break
  369. for k in ('id','symbol'):
  370. for d in data['cc']:
  371. if wants[k]:
  372. if d[k] in wants[k]:
  373. if d[k] in found[k]:
  374. die(1,dup_sym_errmsg(d[k]))
  375. if not 'price_usd' in d:
  376. d['price_usd'] = Decimal(str(d['quotes']['USD']['price']))
  377. d['price_btc'] = Decimal(str(d['quotes']['USD']['price'])) / btcusd
  378. d['percent_change_24h'] = d['quotes']['USD']['percent_change_24h']
  379. d['percent_change_7d'] = d['quotes']['USD']['percent_change_7d']
  380. d['percent_change_30d'] = d['quotes']['USD']['percent_change_30d']
  381. d['percent_change_1y'] = d['quotes']['USD']['percent_change_1y']
  382. # .replace('Z','+00:00') -- Python 3.9 backport
  383. d['last_updated'] = int(datetime.datetime.fromisoformat(d['last_updated'].replace('Z','+00:00')).timestamp())
  384. yield (d['id'],d)
  385. found[k].add(d[k])
  386. wants[k].remove(d[k])
  387. if d[k] in usr_rate_assets_want[k]:
  388. rate_assets[d['symbol']] = d # NB: using symbol instead of ID for key
  389. else:
  390. break
  391. check_assets_found(usr_wants,found)
  392. for asset in (cfg.usr_rows + cfg.usr_columns):
  393. if asset.rate:
  394. """
  395. User-supplied rate overrides rate from source data.
  396. """
  397. _id = asset.id or f'{asset.symbol}-user-asset-{asset.symbol}'.lower()
  398. ra_rate = rate_assets[asset.rate_asset.symbol]['price_usd'] if asset.rate_asset else 1
  399. yield ( _id, {
  400. 'symbol': asset.symbol,
  401. 'id': _id,
  402. 'name': ' '.join(_id.split('-')[1:]),
  403. 'price_usd': ra_rate / asset.rate,
  404. 'price_btc': ra_rate / asset.rate / btcusd,
  405. 'last_updated': None,
  406. })
  407. yield ('usd-us-dollar', {
  408. 'symbol': 'USD',
  409. 'id': 'usd-us-dollar',
  410. 'name': 'US Dollar',
  411. 'price_usd': Decimal(1),
  412. 'price_btc': Decimal(1) / btcusd,
  413. 'last_updated': None,
  414. })
  415. def main():
  416. def update_sample_file(usr_cfg_file):
  417. usr_data = files('mmgen_node_tools').joinpath('data',os.path.basename(usr_cfg_file)).read_text()
  418. sample_file = usr_cfg_file + '.sample'
  419. sample_data = open(sample_file).read() if os.path.exists(sample_file) else None
  420. if usr_data != sample_data:
  421. os.makedirs(os.path.dirname(sample_file),exist_ok=True)
  422. msg('{} {}'.format(
  423. ('Updating','Creating')[sample_data is None],
  424. sample_file ))
  425. open(sample_file,'w').write(usr_data)
  426. try:
  427. from importlib.resources import files # Python 3.9
  428. except ImportError:
  429. from importlib_resources import files
  430. update_sample_file(cfg_in.cfg_file)
  431. update_sample_file(cfg_in.portfolio_file)
  432. if gcfg.portfolio and not cfg_in.portfolio:
  433. die(1,'No portfolio configured!\nTo configure a portfolio, edit the file ~/{}'.format(
  434. os.path.relpath(cfg_in.portfolio_file,start=homedir)))
  435. if gcfg.list_ids:
  436. src_ids = ['cc']
  437. elif gcfg.download:
  438. if not gcfg.download in DataSource.get_sources():
  439. die(1,f'{gcfg.download!r}: invalid data source')
  440. src_ids = [gcfg.download]
  441. else:
  442. src_ids = DataSource.get_sources(randomize=True)
  443. src_data = { k: src_cls[k]().get_data() for k in src_ids }
  444. if gcfg.testing:
  445. return
  446. if gcfg.list_ids:
  447. do_pager('\n'.join(e['id'] for e in src_data['cc']))
  448. return
  449. global now
  450. now = 1659465400 if gcfg.test_suite else time.time() # 1659524400 1659445900
  451. data = dict(gen_data(src_data))
  452. (do_pager if cfg.pager else Msg_r)(
  453. '\n'.join(getattr(Ticker,cfg.clsname)(data).gen_output()) + '\n')
  454. def make_cfg(gcfg_arg):
  455. query_tuple = namedtuple('query',['asset','to_asset'])
  456. asset_data = namedtuple('asset_data',['symbol','id','amount','rate','rate_asset','source'])
  457. def parse_asset_id(s,require_label=False):
  458. return src_cls['fi' if re.match(fi_pat,s) else 'cc'].parse_asset_id(s,require_label)
  459. def get_rows_from_cfg(add_data=None):
  460. def gen():
  461. for n,(k,v) in enumerate(cfg_in.cfg['assets'].items()):
  462. yield k
  463. if add_data and k in add_data:
  464. v += tuple(add_data[k])
  465. for e in v:
  466. yield parse_asset_id(e,require_label=True)
  467. return tuple(gen())
  468. def parse_percent_cols(arg):
  469. if arg is None:
  470. return []
  471. res = arg.lower().split(',')
  472. for s in res:
  473. if s not in percent_cols:
  474. die(1,f'{arg!r}: invalid --percent-cols parameter (valid letters: {fmt_list(percent_cols)})')
  475. return res
  476. def parse_usr_asset_arg(key,use_cf_file=False):
  477. """
  478. asset_id[:rate[:rate_asset]]
  479. """
  480. def parse_parm(s):
  481. ss = s.split(':')
  482. assert len(ss) in (1,2,3), f'{s}: malformed argument'
  483. asset_id,rate,rate_asset = (*ss,None,None)[:3]
  484. parsed_id = parse_asset_id(asset_id)
  485. return asset_data(
  486. symbol = parsed_id.symbol,
  487. id = parsed_id.id,
  488. amount = None,
  489. rate = (
  490. None if rate is None else
  491. 1 / Decimal(rate[:-1]) if rate.lower().endswith('r') else
  492. Decimal(rate) ),
  493. rate_asset = parse_asset_id(rate_asset) if rate_asset else None,
  494. source = parsed_id.source )
  495. cl_opt = getattr(gcfg,key)
  496. cf_opt = cfg_in.cfg.get(key,[]) if use_cf_file else []
  497. return tuple( parse_parm(s) for s in (cl_opt.split(',') if cl_opt else cf_opt) )
  498. def parse_query_arg(s):
  499. """
  500. asset_id:amount[:to_asset_id[:to_amount]]
  501. """
  502. def parse_query_asset(asset_id,amount):
  503. parsed_id = parse_asset_id(asset_id)
  504. return asset_data(
  505. symbol = parsed_id.symbol,
  506. id = parsed_id.id,
  507. amount = None if amount is None else Decimal(amount),
  508. rate = None,
  509. rate_asset = None,
  510. source = parsed_id.source )
  511. ss = s.split(':')
  512. assert len(ss) in (2,3,4), f'{s}: malformed argument'
  513. asset_id,amount,to_asset_id,to_amount = (*ss,None,None)[:4]
  514. return query_tuple(
  515. asset = parse_query_asset(asset_id,amount),
  516. to_asset = parse_query_asset(to_asset_id,to_amount) if to_asset_id else None
  517. )
  518. def gen_uniq(obj_list,key,preload=None):
  519. found = set([getattr(obj,key) for obj in preload if hasattr(obj,key)] if preload else ())
  520. for obj in obj_list:
  521. id = getattr(obj,key)
  522. if id not in found:
  523. yield obj
  524. found.add(id)
  525. def get_usr_assets():
  526. return (
  527. 'user_added',
  528. usr_rows +
  529. (tuple(asset for asset in query if asset) if query else ()) +
  530. usr_columns )
  531. def get_portfolio_assets(ret=()):
  532. if cfg_in.portfolio and gcfg.portfolio:
  533. ret = (parse_asset_id(e,require_label=True) for e in cfg_in.portfolio)
  534. return ( 'portfolio', tuple(e for e in ret if (not gcfg.btc) or e.symbol == 'BTC') )
  535. def get_portfolio():
  536. return {k:Decimal(v) for k,v in cfg_in.portfolio.items() if (not gcfg.btc) or k == 'btc-bitcoin'}
  537. def parse_add_precision(arg):
  538. if not arg:
  539. return 0
  540. s = str(arg)
  541. if not (s.isdigit() and s.isascii()):
  542. die(1,f'{s}: invalid parameter for --add-precision (not an integer)')
  543. if int(s) > 30:
  544. die(1,f'{s}: invalid parameter for --add-precision (value >30)')
  545. return int(s)
  546. def create_rows():
  547. rows = (
  548. ('trade_pair',) + query if (query and query.to_asset) else
  549. ('bitcoin',parse_asset_id('btc-bitcoin')) if gcfg.btc else
  550. get_rows_from_cfg( add_data={'fiat':['usd-us-dollar']} if gcfg.add_columns else None )
  551. )
  552. for hdr,data in (
  553. (get_usr_assets(),) if query else
  554. (get_usr_assets(), get_portfolio_assets())
  555. ):
  556. if data:
  557. uniq_data = tuple(gen_uniq(data,'symbol',preload=rows))
  558. if uniq_data:
  559. rows += (hdr,) + uniq_data
  560. return rows
  561. cfg_tuple = namedtuple('global_cfg',[
  562. 'rows',
  563. 'usr_rows',
  564. 'usr_columns',
  565. 'query',
  566. 'adjust',
  567. 'clsname',
  568. 'btc_only',
  569. 'add_prec',
  570. 'cachedir',
  571. 'proxy',
  572. 'proxy2',
  573. 'portfolio',
  574. 'percent_cols',
  575. 'asset_limit',
  576. 'cached_data',
  577. 'elapsed',
  578. 'name_labels',
  579. 'pager',
  580. 'thousands_comma',
  581. 'update_time',
  582. 'quiet',
  583. 'verbose'])
  584. global gcfg,cfg_in,src_cls,cfg
  585. gcfg = gcfg_arg
  586. src_cls = { k: getattr(DataSource,v) for k,v in DataSource.get_sources().items() }
  587. fi_pat = src_cls['fi'].asset_id_pat
  588. cmd_args = gcfg._args
  589. cfg_in = get_cfg_in()
  590. usr_rows = parse_usr_asset_arg('add_rows')
  591. usr_columns = parse_usr_asset_arg('add_columns',use_cf_file=True)
  592. query = parse_query_arg(cmd_args[0]) if cmd_args else None
  593. def get_proxy(name):
  594. proxy = getattr(gcfg,name)
  595. return (
  596. '' if proxy == '' else 'none' if (proxy and proxy.lower() == 'none')
  597. else (proxy or cfg_in.cfg.get(name))
  598. )
  599. proxy = get_proxy('proxy')
  600. proxy = None if proxy == 'none' else proxy
  601. proxy2 = get_proxy('proxy2')
  602. cfg = cfg_tuple(
  603. rows = create_rows(),
  604. usr_rows = usr_rows,
  605. usr_columns = usr_columns,
  606. query = query,
  607. adjust = ( lambda x: (100 + x) / 100 if x else 1 )( Decimal(gcfg.adjust or 0) ),
  608. clsname = 'trading' if query else 'overview',
  609. btc_only = gcfg.btc or cfg_in.cfg.get('btc'),
  610. add_prec = parse_add_precision(gcfg.add_precision or cfg_in.cfg.get('add_precision')),
  611. cachedir = gcfg.cachedir or cfg_in.cfg.get('cachedir') or dfl_cachedir,
  612. proxy = proxy,
  613. proxy2 = None if proxy2 == 'none' else '' if proxy2 == '' else (proxy2 or proxy),
  614. portfolio =
  615. get_portfolio()
  616. if cfg_in.portfolio
  617. and (gcfg.portfolio or cfg_in.cfg.get('portfolio'))
  618. and not query
  619. else None,
  620. percent_cols = parse_percent_cols(gcfg.percent_cols or cfg_in.cfg.get('percent_cols')),
  621. asset_limit = gcfg.asset_limit or cfg_in.cfg.get('asset_limit'),
  622. cached_data = gcfg.cached_data or cfg_in.cfg.get('cached_data'),
  623. elapsed = gcfg.elapsed or cfg_in.cfg.get('elapsed'),
  624. name_labels = gcfg.name_labels or cfg_in.cfg.get('name_labels'),
  625. pager = gcfg.pager or cfg_in.cfg.get('pager'),
  626. thousands_comma = gcfg.thousands_comma or cfg_in.cfg.get('thousands_comma'),
  627. update_time = gcfg.update_time or cfg_in.cfg.get('update_time'),
  628. quiet = gcfg.quiet or cfg_in.cfg.get('quiet'),
  629. verbose = gcfg.verbose or cfg_in.cfg.get('verbose'),
  630. )
  631. def get_cfg_in():
  632. ret = namedtuple('cfg_in_data',['cfg','portfolio','cfg_file','portfolio_file'])
  633. cfg_file,portfolio_file = (
  634. [os.path.join(gcfg.data_dir_root,'node_tools',fn) for fn in (cfg_fn,portfolio_fn)]
  635. )
  636. cfg_data,portfolio_data = (
  637. [yaml.safe_load(open(fn).read()) if os.path.exists(fn) else None for fn in (cfg_file,portfolio_file)]
  638. )
  639. return ret(
  640. cfg = cfg_data or {
  641. 'assets': {
  642. 'coin': [ 'btc-bitcoin', 'eth-ethereum', 'xmr-monero' ],
  643. # gold futures, silver futures, Brent futures
  644. 'commodity': [ 'gc=f', 'si=f', 'bz=f' ],
  645. # Pound Sterling, Euro, Swiss Franc
  646. 'fiat': [ 'gbpusd=x', 'eurusd=x', 'chfusd=x' ],
  647. # Dow Jones Industrials, Nasdaq 100, S&P 500
  648. 'index': [ '^dji', '^ixic', '^gspc' ],
  649. },
  650. 'proxy': 'http://vpn-gw:8118'
  651. },
  652. portfolio = portfolio_data,
  653. cfg_file = cfg_file,
  654. portfolio_file = portfolio_file,
  655. )
  656. class Ticker:
  657. class base:
  658. offer = None
  659. to_asset = None
  660. def __init__(self,data):
  661. self.comma = ',' if cfg.thousands_comma else ''
  662. self.col1_wid = max(len('TOTAL'),(
  663. max(len(self.create_label(d['id'])) for d in data.values()) if cfg.name_labels else
  664. max(len(d['symbol']) for d in data.values())
  665. )) + 1
  666. self.rows = [row._replace(id=self.get_id(row)) if isinstance(row,tuple) else row for row in cfg.rows]
  667. self.col_usd_prices = {k:self.data[k]['price_usd'] for k in self.col_ids}
  668. self.prices = {row.id:self.get_row_prices(row.id)
  669. for row in self.rows if isinstance(row,tuple) and row.id in data}
  670. self.prices['usd-us-dollar'] = self.get_row_prices('usd-us-dollar')
  671. def format_last_update_col(self,cross_assets=()):
  672. if cfg.elapsed:
  673. from mmgen.util2 import format_elapsed_hr
  674. fmt_func = format_elapsed_hr
  675. else:
  676. fmt_func = lambda t,now: time.strftime('%F %X', time.gmtime(t))
  677. d = self.data
  678. max_w = 0
  679. if cross_assets:
  680. last_updated_x = [d[a.id]['last_updated'] for a in cross_assets]
  681. min_t = min( (int(n) for n in last_updated_x if isinstance(n,int) ), default=None )
  682. else:
  683. min_t = None
  684. for row in self.rows:
  685. if isinstance(row,tuple):
  686. try:
  687. t = int( d[row.id]['last_updated'] )
  688. except TypeError as e:
  689. d[row.id]['last_updated_fmt'] = gray('--' if 'NoneType' in str(e) else str(e))
  690. except KeyError as e:
  691. msg(str(e))
  692. pass
  693. else:
  694. t_fmt = d[row.id]['last_updated_fmt'] = fmt_func(
  695. (min(t,min_t) if min_t else t),
  696. now = now)
  697. max_w = max(len(t_fmt), max_w)
  698. self.upd_w = max_w
  699. def init_prec(self):
  700. exp = [(a.id, self.prices[a.id]['usd-us-dollar'].adjusted()) for a in self.usr_col_assets]
  701. self.uprec = {k: max(0, v+4) + cfg.add_prec for k, v in exp}
  702. self.uwid = {k: 12 + max(0, abs(v)-6) + cfg.add_prec for k, v in exp}
  703. def get_id(self,asset):
  704. if asset.id:
  705. return asset.id
  706. else:
  707. for d in self.data.values():
  708. if d['symbol'] == asset.symbol:
  709. return d['id']
  710. def create_label(self,id):
  711. return self.data[id]['name'].upper()
  712. def gen_output(self):
  713. yield 'Current time: {} UTC'.format(time.strftime('%F %X',time.gmtime(now)))
  714. for asset in self.usr_col_assets:
  715. if asset.symbol != 'USD':
  716. usdprice = self.data[asset.id]['price_usd']
  717. yield '{} ({}) = {:{}.{}f} USD'.format(
  718. asset.symbol,
  719. self.create_label(asset.id),
  720. usdprice,
  721. self.comma,
  722. max(2, 4-usdprice.adjusted()) )
  723. if hasattr(self,'subhdr'):
  724. yield self.subhdr
  725. if self.show_adj:
  726. yield (
  727. ('Offered price differs from spot' if self.offer else 'Adjusting prices')
  728. + ' by '
  729. + yellow('{:+.2f}%'.format( (self.adjust-1) * 100 ))
  730. )
  731. yield ''
  732. if cfg.portfolio:
  733. yield blue('PRICES')
  734. if self.table_hdr:
  735. yield self.table_hdr
  736. for row in self.rows:
  737. if isinstance(row,str):
  738. yield ('-' * self.hl_wid)
  739. else:
  740. try:
  741. yield self.fmt_row(self.data[row.id])
  742. except KeyError:
  743. yield gray(f'(no data for {row.id})')
  744. yield '-' * self.hl_wid
  745. if cfg.portfolio:
  746. self.fs_num = self.fs_num2
  747. self.fs_str = self.fs_str2
  748. yield ''
  749. yield blue('PORTFOLIO')
  750. yield self.table_hdr
  751. yield '-' * self.hl_wid
  752. for sym,amt in cfg.portfolio.items():
  753. try:
  754. yield self.fmt_row(self.data[sym],amt=amt)
  755. except KeyError:
  756. yield gray(f'(no data for {sym})')
  757. yield '-' * self.hl_wid
  758. if not cfg.btc_only:
  759. yield self.fs_num.format(
  760. lbl = 'TOTAL', pc3='', pc4='', pc1='', pc2='', upd='', amt='',
  761. **{ k.replace('-','_'): v for k,v in self.prices['total'].items() }
  762. )
  763. class overview(base):
  764. def __init__(self,data):
  765. self.data = data
  766. self.adjust = cfg.adjust
  767. self.show_adj = self.adjust != 1
  768. self.usr_col_assets = [asset._replace(id=self.get_id(asset)) for asset in cfg.usr_columns]
  769. self.col_ids = ('usd-us-dollar',) + tuple(a.id for a in self.usr_col_assets) + ('btc-bitcoin',)
  770. super().__init__(data)
  771. self.format_last_update_col()
  772. if cfg.portfolio:
  773. self.prices['total'] = { col_id: sum(self.prices[row.id][col_id] * cfg.portfolio[row.id]
  774. for row in self.rows if isinstance(row,tuple) and row.id in cfg.portfolio and row.id in data)
  775. for col_id in self.col_ids }
  776. self.init_prec()
  777. self.init_fs()
  778. def get_row_prices(self,id):
  779. if id in self.data:
  780. d = self.data[id]
  781. return { k: (
  782. d['price_btc'] if k == 'btc-bitcoin' else
  783. d['price_usd'] / self.col_usd_prices[k]
  784. ) * self.adjust for k in self.col_ids }
  785. def fmt_row(self,d,amt=None,amt_fmt=None):
  786. def fmt_pct(n):
  787. return gray(' --') if n == None else (red,green)[n>=0](f'{n:+7.2f}')
  788. p = self.prices[d['id']]
  789. if amt is not None:
  790. amt_fmt = f'{amt:{19+cfg.add_prec}{self.comma}.{8+cfg.add_prec}f}'
  791. if '.' in amt_fmt:
  792. amt_fmt = amt_fmt.rstrip('0').rstrip('.')
  793. return self.fs_num.format(
  794. lbl = self.create_label(d['id']) if cfg.name_labels else d['symbol'],
  795. pc1 = fmt_pct(d.get('percent_change_7d')),
  796. pc2 = fmt_pct(d.get('percent_change_24h')),
  797. pc3 = fmt_pct(d.get('percent_change_1y')),
  798. pc4 = fmt_pct(d.get('percent_change_30d')),
  799. upd = d.get('last_updated_fmt'),
  800. amt = amt_fmt,
  801. **{ k.replace('-','_'): v * (1 if amt is None else amt) for k,v in p.items() }
  802. )
  803. def init_fs(self):
  804. col_prec = {'usd-us-dollar':2+cfg.add_prec,'btc-bitcoin':8+cfg.add_prec } # | self.uprec # Python 3.9
  805. col_prec.update(self.uprec)
  806. col_wid = {'usd-us-dollar':8+cfg.add_prec,'btc-bitcoin':12+cfg.add_prec } # """
  807. col_wid.update(self.uwid)
  808. max_row = max(
  809. ( (k,v['btc-bitcoin']) for k,v in self.prices.items() ),
  810. key = lambda a: a[1]
  811. )
  812. widths = { k: len('{:{}.{}f}'.format( self.prices[max_row[0]][k], self.comma, col_prec[k] ))
  813. for k in self.col_ids }
  814. fd = namedtuple('format_str_data',['fs_str','fs_num','wid'])
  815. col_fs_data = {
  816. 'label': fd(f'{{lbl:{self.col1_wid}}}',f'{{lbl:{self.col1_wid}}}',self.col1_wid),
  817. 'pct1y': fd(' {pc3:7}', ' {pc3:7}', 8),
  818. 'pct1m': fd(' {pc4:7}', ' {pc4:7}', 8),
  819. 'pct1w': fd(' {pc1:7}', ' {pc1:7}', 8),
  820. 'pct1d': fd(' {pc2:7}', ' {pc2:7}', 8),
  821. 'update_time': fd(' {upd}', ' {upd}', max((19 if cfg.portfolio else 0),self.upd_w) + 2),
  822. 'amt': fd(' {amt}', ' {amt}', 21),
  823. }
  824. # } | { k: fd( # Python 3.9
  825. col_fs_data.update({ k: fd(
  826. ' {{{}:>{}}}'.format( k.replace('-','_'), widths[k] ),
  827. ' {{{}:{}{}.{}f}}'.format( k.replace('-','_'), widths[k], self.comma, col_prec[k] ),
  828. widths[k]+2
  829. ) for k in self.col_ids
  830. })
  831. cols = (
  832. ['label','usd-us-dollar'] +
  833. [asset.id for asset in self.usr_col_assets] +
  834. [a for a,b in (
  835. ( 'btc-bitcoin', not cfg.btc_only ),
  836. ( 'pct1y', 'y' in cfg.percent_cols ),
  837. ( 'pct1m', 'm' in cfg.percent_cols ),
  838. ( 'pct1w', 'w' in cfg.percent_cols ),
  839. ( 'pct1d', 'd' in cfg.percent_cols ),
  840. ( 'update_time', cfg.update_time ),
  841. ) if b]
  842. )
  843. cols2 = list(cols)
  844. if cfg.update_time:
  845. cols2.pop()
  846. cols2.append('amt')
  847. self.fs_str = ''.join(col_fs_data[c].fs_str for c in cols)
  848. self.fs_num = ''.join(col_fs_data[c].fs_num for c in cols)
  849. self.hl_wid = sum(col_fs_data[c].wid for c in cols)
  850. self.fs_str2 = ''.join(col_fs_data[c].fs_str for c in cols2)
  851. self.fs_num2 = ''.join(col_fs_data[c].fs_num for c in cols2)
  852. self.hl_wid2 = sum(col_fs_data[c].wid for c in cols2)
  853. @property
  854. def table_hdr(self):
  855. return self.fs_str.format(
  856. lbl = '',
  857. pc1 = ' CHG_7d',
  858. pc2 = 'CHG_24h',
  859. pc3 = 'CHG_1y',
  860. pc4 = 'CHG_30d',
  861. upd = 'UPDATED',
  862. amt = ' AMOUNT',
  863. usd_us_dollar = 'USD',
  864. btc_bitcoin = ' BTC',
  865. **{ a.id.replace('-','_'): a.symbol for a in self.usr_col_assets }
  866. )
  867. class trading(base):
  868. def __init__(self,data):
  869. self.data = data
  870. self.asset = cfg.query.asset._replace(id=self.get_id(cfg.query.asset))
  871. self.to_asset = (
  872. cfg.query.to_asset._replace(id=self.get_id(cfg.query.to_asset))
  873. if cfg.query.to_asset else None )
  874. self.col_ids = [self.asset.id]
  875. self.adjust = cfg.adjust
  876. if self.to_asset:
  877. self.offer = self.to_asset.amount
  878. if self.offer:
  879. real_price = (
  880. self.asset.amount
  881. * data[self.asset.id]['price_usd']
  882. / data[self.to_asset.id]['price_usd']
  883. )
  884. if self.adjust != 1:
  885. die(1,'the --adjust option may not be combined with TO_AMOUNT in the trade specifier')
  886. self.adjust = self.offer / real_price
  887. self.hl_ids = [self.asset.id,self.to_asset.id]
  888. else:
  889. self.hl_ids = [self.asset.id]
  890. self.show_adj = self.adjust != 1 or self.offer
  891. super().__init__(data)
  892. self.usr_col_assets = [self.asset] + ([self.to_asset] if self.to_asset else [])
  893. for a in self.usr_col_assets:
  894. self.prices[a.id]['usd-us-dollar'] = data[a.id]['price_usd']
  895. self.format_last_update_col(cross_assets=self.usr_col_assets)
  896. self.init_prec()
  897. self.init_fs()
  898. def get_row_prices(self,id):
  899. if id in self.data:
  900. d = self.data[id]
  901. return { k: self.col_usd_prices[self.asset.id] / d['price_usd'] for k in self.col_ids }
  902. def init_fs(self):
  903. self.max_wid = max(
  904. len('{:{}{}.{}f}'.format(
  905. v[self.asset.id] * self.asset.amount,
  906. 16 + cfg.add_prec,
  907. self.comma,
  908. 8 + cfg.add_prec
  909. ))
  910. for v in self.prices.values()
  911. )
  912. self.fs_str = '{lbl:%s} {p_spot}' % self.col1_wid
  913. self.hl_wid = self.col1_wid + self.max_wid + 1
  914. if self.show_adj:
  915. self.fs_str += ' {p_adj}'
  916. self.hl_wid += self.max_wid + 1
  917. if cfg.update_time:
  918. self.fs_str += ' {upd}'
  919. self.hl_wid += self.upd_w + 2
  920. def fmt_row(self,d):
  921. id = d['id']
  922. p = self.prices[id][self.asset.id] * self.asset.amount
  923. p_spot = '{:{}{}.{}f}'.format( p, self.max_wid, self.comma, 8+cfg.add_prec )
  924. p_adj = (
  925. '{:{}{}.{}f}'.format( p*self.adjust, self.max_wid, self.comma, 8+cfg.add_prec )
  926. if self.show_adj else '' )
  927. return self.fs_str.format(
  928. lbl = self.create_label(id) if cfg.name_labels else d['symbol'],
  929. p_spot = green(p_spot) if id in self.hl_ids else p_spot,
  930. p_adj = yellow(p_adj) if id in self.hl_ids else p_adj,
  931. upd = d.get('last_updated_fmt'),
  932. )
  933. @property
  934. def table_hdr(self):
  935. return self.fs_str.format(
  936. lbl = '',
  937. p_spot = '{t:>{w}}'.format(
  938. t = 'SPOT PRICE',
  939. w = self.max_wid ),
  940. p_adj = '{t:>{w}}'.format(
  941. t = ('OFFERED' if self.offer else 'ADJUSTED') + ' PRICE',
  942. w = self.max_wid ),
  943. upd = 'UPDATED'
  944. )
  945. @property
  946. def subhdr(self):
  947. return (
  948. '{a}: {b:{c}} {d}'.format(
  949. a = 'Offer' if self.offer else 'Amount',
  950. b = self.asset.amount,
  951. c = self.comma,
  952. d = self.asset.symbol
  953. ) + (
  954. (
  955. ' =>' +
  956. (' {:{}}'.format(self.offer,self.comma) if self.offer else '') +
  957. ' {} ({})'.format(
  958. self.to_asset.symbol,
  959. self.create_label(self.to_asset.id) )
  960. ) if self.to_asset else '' )
  961. )