ts_xmr_autosign.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, a command-line cryptocurrency wallet
  4. # Copyright (C)2013-2023 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
  9. # https://gitlab.com/mmgen/mmgen
  10. """
  11. test.test_py_d.ts_xmr_autosign: xmr autosigning tests for the test.py test suite
  12. """
  13. from .ts_xmrwallet import *
  14. from pathlib import Path
  15. from .ts_autosign import TestSuiteAutosignBase
  16. def make_burn_addr():
  17. from mmgen.tool.coin import tool_cmd
  18. return tool_cmd(
  19. cfg = cfg,
  20. cmdname = 'privhex2addr',
  21. proto = cfg._proto,
  22. mmtype = 'monero' ).privhex2addr('beadcafe'*8)
  23. class TestSuiteXMRAutosign(TestSuiteXMRWallet,TestSuiteAutosignBase):
  24. """
  25. Monero autosigning operations
  26. """
  27. tmpdir_nums = [39]
  28. # ts_xmrwallet attrs:
  29. user_data = (
  30. ('miner', '98831F3A', False, 130, '1', []),
  31. ('alice', 'FE3C6545', True, 150, '1-2', []),
  32. )
  33. # ts_autosign attrs:
  34. coins = ['xmr']
  35. daemon_coins = []
  36. txfile_coins = []
  37. live = False
  38. simulate = False
  39. bad_tx_count = 0
  40. tx_relay_user = 'miner'
  41. no_insert_check = False
  42. win_skip = True
  43. cmd_group = (
  44. ('daemon_version', 'checking daemon version'),
  45. ('create_tmp_wallets', 'creating temporary online wallets for Alice'),
  46. ('new_account_alice', 'adding an account to Alice’s tmp wallet'),
  47. ('new_address_alice', 'adding an address to Alice’s tmp wallet'),
  48. ('new_address_alice_label', 'adding an address to Alice’s tmp wallet (with label)'),
  49. ('dump_tmp_wallets', 'dumping Alice’s tmp wallets'),
  50. ('delete_tmp_wallets', 'deleting Alice’s tmp wallets'),
  51. ('autosign_clean', 'cleaning signable file directories'),
  52. ('autosign_setup', 'autosign setup with Alice’s seed'),
  53. ('create_watchonly_wallets', 'creating online (watch-only) wallets for Alice'),
  54. ('delete_tmp_dump_files', 'deleting Alice’s dump files'),
  55. ('gen_kafiles', 'generating key-address files for Miner'),
  56. ('create_wallets_miner', 'creating Monero wallets for Miner'),
  57. ('mine_initial_coins', 'mining initial coins'),
  58. ('fund_alice1', 'sending funds to Alice (wallet #1)'),
  59. ('fund_alice2', 'sending funds to Alice (wallet #2)'),
  60. ('autosign_start_thread', 'starting autosign wait loop'),
  61. ('create_transfer_tx1', 'creating a transfer TX'),
  62. ('submit_transfer_tx1', 'submitting the transfer TX'),
  63. ('resubmit_transfer_tx1', 'resubmitting the transfer TX'),
  64. ('export_outputs1', 'exporting outputs from Alice’s watch-only wallet #1'),
  65. ('import_key_images1', 'importing signed key images into Alice’s online wallets'),
  66. ('sync_chkbal1', 'syncing Alice’s wallet #1'),
  67. ('create_transfer_tx2', 'creating a transfer TX (for relaying via proxy)'),
  68. ('submit_transfer_tx2', 'submitting the transfer TX (relaying via proxy)'),
  69. ('sync_chkbal2', 'syncing Alice’s wallets and checking balance'),
  70. ('dump_wallets', 'dumping Alice’s wallets'),
  71. ('delete_wallets', 'deleting Alice’s wallets'),
  72. ('restore_wallets', 'creating online (watch-only) wallets for Alice'),
  73. ('delete_dump_files', 'deleting Alice’s dump files'),
  74. ('export_outputs2', 'exporting outputs from Alice’s watch-only wallets'),
  75. ('import_key_images2', 'importing signed key images into Alice’s online wallets'),
  76. ('sync_chkbal3', 'syncing Alice’s wallets and checking balance'),
  77. ('txlist', 'listing Alice’s submitted transactions'),
  78. ('check_tx_dirs', 'cleaning and checking signable file directories'),
  79. ('autosign_kill_thread', 'stopping autosign wait loop'),
  80. ('stop_daemons', 'stopping all wallet and coin daemons'),
  81. )
  82. def __init__(self,trunner,cfgs,spawn):
  83. TestSuiteXMRWallet.__init__(self,trunner,cfgs,spawn)
  84. TestSuiteAutosignBase.__init__(self,trunner,cfgs,spawn)
  85. if trunner == None:
  86. return
  87. from mmgen.cfg import Config
  88. self.cfg = Config({
  89. 'coin': 'XMR',
  90. 'outdir': self.users['alice'].udir,
  91. 'wallet_dir': self.users['alice'].udir,
  92. 'wallet_rpc_password': 'passwOrd',
  93. 'test_suite': True,
  94. })
  95. self.burn_addr = make_burn_addr()
  96. self.opts.append('--xmrwallets={}'.format( self.users['alice'].kal_range )) # mmgen-autosign opts
  97. self.autosign_opts = [f'--autosign-mountpoint={self.mountpoint}'] # mmgen-xmrwallet opts
  98. self.tx_count = 1
  99. self.spawn_env['MMGEN_TEST_SUITE_XMR_AUTOSIGN'] = '1'
  100. def create_tmp_wallets(self):
  101. self.spawn('',msg_only=True)
  102. data = self.users['alice']
  103. from mmgen.wallet import Wallet
  104. from mmgen.xmrwallet import MoneroWalletOps,xmrwallet_uargs
  105. silence()
  106. kal = KeyAddrList(
  107. cfg = self.cfg,
  108. proto = self.proto,
  109. addr_idxs = '1-2',
  110. seed = Wallet(cfg,data.mmwords).seed,
  111. skip_chksum_msg = True,
  112. key_address_validity_check = False )
  113. kal.file.write(ask_overwrite=False)
  114. fn = get_file_with_ext(data.udir,'akeys')
  115. m = MoneroWalletOps.create(
  116. self.cfg,
  117. xmrwallet_uargs(fn, '1-2', None))
  118. async_run(m.main())
  119. async_run(m.stop_wallet_daemon())
  120. end_silence()
  121. return 'ok'
  122. def _new_addr_alice(self,*args):
  123. data = self.users['alice']
  124. return self.new_addr_alice(
  125. *args,
  126. kafile = get_file_with_ext(data.udir,'akeys') )
  127. def new_account_alice(self):
  128. return self._new_addr_alice(
  129. '2',
  130. 'start',
  131. fr'Creating new account.*Index:\s+{self.na_idx}\s')
  132. def new_address_alice(self):
  133. return self._new_addr_alice(
  134. '2:1',
  135. 'continue',
  136. fr'Account index:\s+1\s+Creating new address' )
  137. def new_address_alice_label(self):
  138. return self._new_addr_alice(
  139. '2:1,Alice’s new address',
  140. 'stop',
  141. fr'Account index:\s+1\s+Creating new address.*Alice’s new address' )
  142. def dump_tmp_wallets(self):
  143. return self._dump_wallets(autosign=False)
  144. def dump_wallets(self):
  145. return self._dump_wallets(autosign=True)
  146. def _dump_wallets(self,autosign):
  147. data = self.users['alice']
  148. t = self.spawn(
  149. 'mmgen-xmrwallet',
  150. self.extra_opts
  151. + [f'--wallet-dir={data.udir}', f'--daemon=localhost:{data.md.rpc_port}']
  152. + (self.autosign_opts if autosign else [])
  153. + ['dump']
  154. + ([] if autosign else [get_file_with_ext(data.udir,'akeys')]) )
  155. t.expect('2 wallets dumped')
  156. return t
  157. def _delete_files(self,*ext_list):
  158. data = self.users['alice']
  159. self.spawn('',msg_only=True)
  160. for ext in ext_list:
  161. get_file_with_ext(data.udir,ext,no_dot=True,delete_all=True)
  162. return 'ok'
  163. def delete_tmp_wallets(self):
  164. return self._delete_files( 'MoneroWallet', 'MoneroWallet.keys', '.akeys' )
  165. def delete_wallets(self):
  166. return self._delete_files( 'MoneroWatchOnlyWallet', '.keys', '.address.txt' )
  167. def delete_tmp_dump_files(self):
  168. return self._delete_files( '.dump' )
  169. def delete_dump_files(self):
  170. return self._delete_files( '.dump' )
  171. def fund_alice1(self):
  172. return self.fund_alice(wallet=1,check_bal=False)
  173. def fund_alice2(self):
  174. return self.fund_alice(wallet=2)
  175. def insert_device(self):
  176. self.asi.dev_disk_path.touch()
  177. def autosign_setup(self):
  178. self.insert_device()
  179. Path(self.autosign_xmr_dir).mkdir(parents=True,exist_ok=True)
  180. Path(self.autosign_xmr_dir,'old.vkeys').touch()
  181. t = self.run_setup(
  182. mn_type = 'mmgen',
  183. mn_file = self.users['alice'].mmwords,
  184. use_dfl_wallet = None )
  185. t.expect('Continue with Monero setup? (Y/n): ','y')
  186. t.written_to_file('View keys')
  187. return t
  188. def autosign_start_thread(self):
  189. if self.asi.dev_disk_path.exists():
  190. self.asi.dev_disk_path.unlink()
  191. def run():
  192. t = self.spawn('mmgen-autosign', self.opts + ['wait'], direct_exec=True )
  193. self.write_to_tmpfile('autosign_thread_pid',str(t.ep.pid))
  194. import threading
  195. threading.Thread( target=run, name='Autosign wait loop' ).start()
  196. time.sleep(0.2)
  197. return 'silent'
  198. def autosign_kill_thread(self):
  199. self.spawn('',msg_only=True)
  200. pid = int(self.read_from_tmpfile('autosign_thread_pid'))
  201. self.delete_tmpfile('autosign_thread_pid')
  202. from signal import SIGTERM
  203. imsg(purple(f'Killing autosign wait loop [PID {pid}]'))
  204. try:
  205. os.kill(pid,SIGTERM)
  206. except:
  207. imsg(yellow(f'{pid}: no such process'))
  208. return 'ok'
  209. def create_watchonly_wallets(self):
  210. return self.create_wallets( 'alice', op='restore' )
  211. def restore_wallets(self):
  212. return self.create_wallets( 'alice', op='restore' )
  213. def _create_transfer_tx(self,amt):
  214. t = self.do_op('transfer','alice',f'1:0:{self.burn_addr},{amt}',no_relay=True,do_ret=True)
  215. t.read() # required!
  216. self.insert_device()
  217. return t
  218. def create_transfer_tx1(self):
  219. return self._create_transfer_tx('0.124')
  220. def create_transfer_tx2(self):
  221. get_file_with_ext(self.asi.xmr_tx_dir,'rawtx',delete_all=True)
  222. get_file_with_ext(self.asi.xmr_tx_dir,'sigtx',delete_all=True)
  223. return self._create_transfer_tx('0.257')
  224. def _xmr_autosign_op(self,op,desc=None,dtype=None,ext=None,wallet_arg=None,add_opts=[],wait_signed=False):
  225. if wait_signed:
  226. oqmsg_r(gray(f'→ offline wallet{"s" if dtype.endswith("s") else ""} signing {dtype}'))
  227. while True:
  228. oqmsg_r(gray('.'))
  229. if not self.asi.dev_disk_path.exists():
  230. break
  231. time.sleep(0.5)
  232. oqmsg(gray('done'))
  233. data = self.users['alice']
  234. args = (
  235. self.extra_opts
  236. + self.autosign_opts
  237. + [f'--wallet-dir={data.udir}', f'--daemon=localhost:{data.md.rpc_port}']
  238. + add_opts
  239. + [ op ]
  240. + ([get_file_with_ext(self.asi.xmr_tx_dir,ext)] if ext else [])
  241. + ([wallet_arg] if wallet_arg else [])
  242. )
  243. desc_pfx = f'{desc}, ' if desc else ''
  244. return self.spawn( 'mmgen-xmrwallet', args, extra_desc=f'({desc_pfx}Alice)' )
  245. def _sync_chkbal(self,wallet_arg,bal_chk_func):
  246. return self.sync_wallets(
  247. 'alice',
  248. op = 'sync',
  249. wallets = wallet_arg,
  250. bal_chk_func = bal_chk_func )
  251. def sync_chkbal1(self):
  252. return self._sync_chkbal( '1', lambda n,b,ub: b == ub and 1 < b < 1.12 )
  253. # 1.234567891234 - 0.124 = 1.110567891234 (minus fees)
  254. def sync_chkbal2(self):
  255. return self._sync_chkbal( '1', lambda n,b,ub: b == ub and 0.8 < b < 0.86 )
  256. # 1.234567891234 - 0.124 - 0.257 = 0.853567891234 (minus fees)
  257. def sync_chkbal3(self):
  258. return self._sync_chkbal(
  259. '1-2',
  260. lambda n,b,ub: b == ub and ((n == 1 and 0.8 < b < 0.86) or (n == 2 and b > 1.23)) )
  261. def _mine_chk(self,desc):
  262. bal_type = {'locked':'b','unlocked':'ub'}[desc]
  263. return self.mine_chk(
  264. 'alice', 1, 0,
  265. lambda x: 0 < getattr(x,bal_type) < 1.234567891234,
  266. f'{desc} balance 0 < 1.234567891234' )
  267. def submit_transfer_tx1(self):
  268. return self._submit_transfer_tx( ext='sigtx' )
  269. def resubmit_transfer_tx1(self):
  270. return self._submit_transfer_tx( relay_parm=self.tx_relay_daemon_proxy_parm, op='resubmit', check_bal=False )
  271. def submit_transfer_tx2(self):
  272. return self._submit_transfer_tx( relay_parm=self.tx_relay_daemon_parm )
  273. def _submit_transfer_tx(self,relay_parm=None,ext=None,op='submit',check_bal=True):
  274. data = self.users['alice']
  275. t = self._xmr_autosign_op(
  276. op = op,
  277. add_opts = [f'--tx-relay-daemon={relay_parm}'] if relay_parm else [],
  278. ext = ext,
  279. dtype = 'transaction',
  280. wait_signed = op == 'submit' )
  281. t.expect( f'{op.capitalize()} transaction? (y/N): ', 'y' )
  282. t.written_to_file('Submitted transaction')
  283. if check_bal:
  284. t.ok()
  285. return self._mine_chk('unlocked')
  286. else:
  287. return t
  288. def _export_outputs(self,wallet_arg,add_opts=[]):
  289. t = self._xmr_autosign_op(
  290. op = 'export-outputs',
  291. wallet_arg = wallet_arg,
  292. add_opts = add_opts )
  293. t.written_to_file('Wallet outputs')
  294. t.read() # required!
  295. self.insert_device()
  296. return t
  297. def export_outputs1(self):
  298. return self._export_outputs('1',['--rescan-blockchain'])
  299. def export_outputs2(self):
  300. return self._export_outputs('1-2')
  301. def _import_key_images(self,wallet_arg):
  302. return self._xmr_autosign_op(
  303. op = 'import-key-images',
  304. wallet_arg = wallet_arg,
  305. dtype = 'wallet outputs',
  306. wait_signed = True )
  307. def import_key_images1(self):
  308. return self._import_key_images(None)
  309. def import_key_images2(self):
  310. return self._import_key_images(None)
  311. def create_fake_tx_files(self):
  312. imsg('Creating fake transaction files')
  313. self.asi.msg_dir.mkdir(exist_ok=True)
  314. self.asi.xmr_dir.mkdir(exist_ok=True)
  315. self.asi.xmr_tx_dir.mkdir(exist_ok=True)
  316. self.asi.xmr_outputs_dir.mkdir(exist_ok=True)
  317. for fn in (
  318. 'a.rawtx', 'a.sigtx',
  319. 'b.rawtx', 'b.sigtx',
  320. 'c.rawtx',
  321. 'd.sigtx',
  322. ):
  323. (self.asi.tx_dir / fn).touch()
  324. for fn in (
  325. 'a.rawmsg.json', 'a.sigmsg.json',
  326. 'b.rawmsg.json',
  327. 'c.sigmsg.json',
  328. 'd.rawmsg.json', 'd.sigmsg.json',
  329. ):
  330. (self.asi.msg_dir / fn).touch()
  331. for fn in (
  332. 'a.rawtx', 'a.sigtx', 'a.subtx',
  333. 'b.rawtx', 'b.sigtx',
  334. 'c.subtx',
  335. 'd.rawtx', 'd.subtx',
  336. 'e.rawtx',
  337. 'f.sigtx','f.subtx',
  338. ):
  339. (self.asi.xmr_tx_dir / fn).touch()
  340. for fn in (
  341. 'a.raw', 'a.sig',
  342. 'b.raw',
  343. 'c.sig',
  344. ):
  345. (self.asi.xmr_outputs_dir / fn).touch()
  346. return 'ok'
  347. def _gen_listing(self):
  348. for k in ('tx_dir','msg_dir','xmr_tx_dir','xmr_outputs_dir'):
  349. d = getattr(self.asi,k)
  350. if d.is_dir():
  351. yield '{:12} {}'.format(
  352. str(Path(*d.parts[4:])) + ':',
  353. ' '.join(sorted(i.name for i in d.iterdir()))).strip()
  354. def autosign_clean(self):
  355. self.create_fake_tx_files()
  356. before = '\n'.join(self._gen_listing())
  357. t = self.spawn( 'mmgen-autosign', [f'--mountpoint={self.mountpoint}','clean'] )
  358. out = t.read()
  359. after = '\n'.join(self._gen_listing())
  360. chk = """
  361. tx: a.sigtx b.sigtx c.rawtx d.sigtx
  362. msg: a.sigmsg.json b.rawmsg.json c.sigmsg.json d.sigmsg.json
  363. xmr/tx: a.subtx b.sigtx c.subtx d.subtx e.rawtx f.subtx
  364. xmr/outputs:
  365. """
  366. shutil.rmtree(self.asi.mountpoint)
  367. self.asi.tx_dir.mkdir(parents=True)
  368. imsg(f'\nBefore cleaning:\n{before}')
  369. imsg(f'\nAfter cleaning:\n{after}')
  370. assert '13 files shredded' in out
  371. assert after + '\n' == fmt(chk), f'\n{after}\n!=\n{fmt(chk)}'
  372. return t
  373. def txlist(self):
  374. t = self.spawn( 'mmgen-xmrwallet', self.autosign_opts + ['txlist'] )
  375. t.match_expect_list([
  376. 'SUBMITTED',
  377. 'Network','Submitted',
  378. 'Transfer 1:0','-> ext',
  379. 'Transfer 1:0','-> ext'
  380. ])
  381. return t
  382. def check_tx_dirs(self):
  383. before = '\n'.join(self._gen_listing())
  384. t = self.spawn( 'mmgen-autosign', [f'--mountpoint={self.mountpoint}','clean'] )
  385. t.read()
  386. after = '\n'.join(self._gen_listing())
  387. imsg(f'\nBefore cleaning:\n{before}')
  388. imsg(f'\nAfter cleaning:\n{after}')
  389. pat = r'xmr/tx: \s*\S+\.subtx \S+\.subtx\s+xmr/outputs:\s*$'
  390. assert re.search( pat, after, re.DOTALL ), f'regex search for {pat} failed'
  391. return t