ct_xmr_autosign.py 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, a command-line cryptocurrency wallet
  4. # Copyright (C)2013-2024 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
  9. # https://gitlab.com/mmgen/mmgen-wallet
  10. """
  11. test.cmdtest_py_d.ct_xmr_autosign: xmr autosigning tests for the cmdtest.py test suite
  12. """
  13. import os,time,re,shutil
  14. from pathlib import Path
  15. from mmgen.color import purple,gray,blue,cyan,brown
  16. from mmgen.util import fmt,async_run
  17. from ..include.common import cfg,imsg,silence,end_silence
  18. from .common import get_file_with_ext
  19. from .ct_xmrwallet import CmdTestXMRWallet
  20. from .ct_autosign import CmdTestAutosignThreaded
  21. def make_burn_addr():
  22. from mmgen.tool.coin import tool_cmd
  23. return tool_cmd(
  24. cfg = cfg,
  25. cmdname = 'privhex2addr',
  26. proto = cfg._proto,
  27. mmtype = 'monero' ).privhex2addr('beadcafe'*8)
  28. class CmdTestXMRAutosign(CmdTestXMRWallet,CmdTestAutosignThreaded):
  29. """
  30. Monero autosigning operations
  31. """
  32. tmpdir_nums = [39]
  33. # ct_xmrwallet attrs:
  34. tx_relay_user = 'miner'
  35. # user sid autosign shift kal_range add_coind_args
  36. user_data = (
  37. ('miner', '98831F3A', False, 130, '1', []),
  38. ('alice', 'FE3C6545', True, 150, '1-2', []),
  39. )
  40. # ct_autosign attrs:
  41. coins = ['xmr']
  42. cmd_group = (
  43. ('daemon_version', 'checking daemon version'),
  44. ('gen_kafile_miner', 'generating key-address file for Miner'),
  45. ('create_wallet_miner', 'creating Monero wallet for Miner'),
  46. ('mine_initial_coins', 'mining initial coins'),
  47. ('create_tmp_wallets', 'creating temporary online wallets for Alice'),
  48. ('new_account_alice', 'adding an account to Alice’s tmp wallet'),
  49. ('new_address_alice', 'adding an address to Alice’s tmp wallet'),
  50. ('new_address_alice_label', 'adding an address to Alice’s tmp wallet (with label)'),
  51. ('dump_tmp_wallets', 'dumping Alice’s tmp wallets'),
  52. ('delete_tmp_wallets', 'deleting Alice’s tmp wallets'),
  53. ('autosign_setup', 'autosign setup with Alice’s seed'),
  54. ('autosign_xmr_setup', 'autosign setup (creation of Monero signing wallets)'),
  55. ('create_watchonly_wallets', 'creating watch-only wallets from Alice’s wallet dumps'),
  56. ('delete_tmp_dump_files', 'deleting Alice’s dump files'),
  57. ('fund_alice1', 'sending funds to Alice (wallet #1)'),
  58. ('check_bal_alice1', 'mining, checking balance (wallet #1)'),
  59. ('fund_alice2', 'sending funds to Alice (wallet #2)'),
  60. ('check_bal_alice2', 'mining, checking balance (wallet #2)'),
  61. ('wait_loop_start', 'starting autosign wait loop'),
  62. ('export_outputs1', 'exporting outputs from Alice’s watch-only wallet #1'),
  63. ('create_transfer_tx1', 'creating a transfer TX'),
  64. ('submit_transfer_tx1', 'submitting the transfer TX'),
  65. ('resubmit_transfer_tx1', 'resubmitting the transfer TX'),
  66. ('export_outputs2', 'exporting outputs from Alice’s watch-only wallet #1'),
  67. ('import_key_images1', 'importing signed key images into Alice’s online wallets'),
  68. ('sync_chkbal1', 'syncing Alice’s wallet #1'),
  69. ('abort_tx1', 'aborting the current transaction (error)'),
  70. ('create_transfer_tx2', 'creating a transfer TX (for relaying via proxy)'),
  71. ('abort_tx2', 'aborting the current transaction (OK, unsigned)'),
  72. ('create_transfer_tx2a', 'creating the transfer TX again'),
  73. ('submit_transfer_tx2', 'submitting the transfer TX (relaying via proxy)'),
  74. ('sync_chkbal2', 'syncing Alice’s wallets and checking balance'),
  75. ('dump_wallets', 'dumping Alice’s wallets'),
  76. ('delete_wallets', 'deleting Alice’s wallets'),
  77. ('restore_wallets', 'creating online (watch-only) wallets for Alice'),
  78. ('delete_dump_files', 'deleting Alice’s dump files'),
  79. ('export_outputs3', 'exporting outputs from Alice’s watch-only wallets'),
  80. ('import_key_images2', 'importing signed key images into Alice’s online wallets'),
  81. ('sync_chkbal3', 'syncing Alice’s wallets and checking balance'),
  82. ('wait_loop_kill', 'stopping autosign wait loop'),
  83. ('stop_daemons', 'stopping all wallet and coin daemons'),
  84. ('view', 'viewing Alice’s wallet in offline mode (wallet #1)'),
  85. ('listview', 'list-viewing Alice’s wallet in offline mode (wallet #2)'),
  86. ('txlist', 'listing Alice’s submitted transactions'),
  87. ('txview', 'viewing Alice’s submitted transactions'),
  88. ('txview_all', 'viewing all raw, signed and submitted transactions'),
  89. ('check_tx_dirs', 'cleaning and checking signable file directories'),
  90. )
  91. def __init__(self,trunner,cfgs,spawn):
  92. CmdTestAutosignThreaded.__init__(self,trunner,cfgs,spawn)
  93. CmdTestXMRWallet.__init__(self,trunner,cfgs,spawn)
  94. if trunner is None:
  95. return
  96. from mmgen.cfg import Config
  97. self.cfg = Config({
  98. 'coin': 'XMR',
  99. 'outdir': self.users['alice'].udir,
  100. 'wallet_dir': self.users['alice'].udir,
  101. 'wallet_rpc_password': 'passwOrd',
  102. 'test_suite': True,
  103. })
  104. self.burn_addr = make_burn_addr()
  105. self.opts.append('--xmrwallets={}'.format(self.users['alice'].kal_range)) # mmgen-autosign opts
  106. self.autosign_opts = ['--autosign'] # mmgen-xmrwallet opts
  107. self.spawn_env['MMGEN_TEST_SUITE_XMR_AUTOSIGN'] = '1'
  108. def create_tmp_wallets(self):
  109. self.spawn('',msg_only=True)
  110. data = self.users['alice']
  111. from mmgen.wallet import Wallet
  112. from mmgen.xmrwallet import MoneroWalletOps,xmrwallet_uargs
  113. from mmgen.addrlist import KeyAddrList
  114. silence()
  115. kal = KeyAddrList(
  116. cfg = self.cfg,
  117. proto = self.proto,
  118. addr_idxs = '1-2',
  119. seed = Wallet(cfg,data.mmwords).seed,
  120. skip_chksum_msg = True,
  121. key_address_validity_check = False )
  122. kal.file.write(ask_overwrite=False)
  123. fn = get_file_with_ext(data.udir,'akeys')
  124. m = MoneroWalletOps.create(
  125. self.cfg,
  126. xmrwallet_uargs(fn, '1-2', None))
  127. async_run(m.main())
  128. async_run(m.stop_wallet_daemon())
  129. end_silence()
  130. return 'ok'
  131. def _new_addr_alice(self,*args):
  132. data = self.users['alice']
  133. return self.new_addr_alice(
  134. *args,
  135. kafile = get_file_with_ext(data.udir,'akeys') )
  136. def new_account_alice(self):
  137. return self._new_addr_alice(
  138. '2',
  139. 'start',
  140. r'Creating new account for wallet .*2.* with label .*‘xmrwallet new account .*y/N\): ')
  141. def new_address_alice(self):
  142. return self._new_addr_alice(
  143. '2:1',
  144. 'continue',
  145. r'Creating new address for wallet .*2.*, account .*#1.* with label .*‘xmrwallet new address .*y/N\): ')
  146. def new_address_alice_label(self):
  147. return self._new_addr_alice(
  148. '2:1,Alice’s new address',
  149. 'stop',
  150. r'Creating new address for wallet .*2.*, account .*#1.* with label .*‘Alice’s new address .*y/N\): ')
  151. def dump_tmp_wallets(self):
  152. return self._dump_wallets(autosign=False)
  153. def dump_wallets(self):
  154. return self._dump_wallets(autosign=True)
  155. def _dump_wallets(self,autosign):
  156. data = self.users['alice']
  157. self.insert_device_online()
  158. t = self.spawn(
  159. 'mmgen-xmrwallet',
  160. self.extra_opts
  161. + [f'--wallet-dir={data.udir}', f'--daemon=localhost:{data.md.rpc_port}']
  162. + (self.autosign_opts if autosign else [])
  163. + ['dump']
  164. + ([] if autosign else [get_file_with_ext(data.udir,'akeys')]) )
  165. t.expect('2 wallets dumped')
  166. t.read()
  167. self.remove_device_online()
  168. return t
  169. def _delete_files(self,*ext_list):
  170. data = self.users['alice']
  171. self.spawn('',msg_only=True)
  172. for ext in ext_list:
  173. get_file_with_ext(data.udir,ext,no_dot=True,delete_all=True)
  174. return 'ok'
  175. def delete_tmp_wallets(self):
  176. return self._delete_files( 'MoneroWallet', 'MoneroWallet.keys', '.akeys' )
  177. def delete_wallets(self):
  178. return self._delete_files( 'MoneroWatchOnlyWallet', '.keys', '.address.txt' )
  179. def delete_tmp_dump_files(self):
  180. return self._delete_files( '.dump' )
  181. def gen_kafile_miner(self):
  182. return self.gen_kafiles(['miner'])
  183. def create_wallet_miner(self):
  184. return self.create_wallets_miner()
  185. def delete_dump_files(self):
  186. return self._delete_files( '.dump' )
  187. def fund_alice1(self):
  188. return self.fund_alice(wallet=1)
  189. def check_bal_alice1(self):
  190. return self.check_bal_alice(wallet=1)
  191. def fund_alice2(self):
  192. return self.fund_alice(wallet=2)
  193. def check_bal_alice2(self):
  194. return self.check_bal_alice(wallet=2)
  195. def autosign_setup(self):
  196. return self.run_setup(
  197. mn_type = 'mmgen',
  198. mn_file = self.users['alice'].mmwords,
  199. use_dfl_wallet = None,
  200. expect_args = ['Continue with Monero setup? (Y/n): ', 'n'])
  201. def autosign_xmr_setup(self):
  202. self.insert_device_online()
  203. self.do_mount_online()
  204. self.asi_online.xmr_dir.mkdir(exist_ok=True)
  205. (self.asi_online.xmr_dir / 'old.vkeys').touch()
  206. self.do_umount_online()
  207. self.remove_device_online()
  208. self.insert_device()
  209. t = self.spawn('mmgen-autosign', self.opts + ['xmr_setup'], no_passthru_opts=True)
  210. t.written_to_file('View keys')
  211. t.read()
  212. self.remove_device()
  213. return t
  214. def create_watchonly_wallets(self):
  215. return self.restore_wallets()
  216. def restore_wallets(self):
  217. self.insert_device_online()
  218. t = self.create_wallets('alice', op='restore')
  219. t.read() # required!
  220. self.remove_device_online()
  221. return t
  222. def _create_transfer_tx(self, amt, add_opts=[]):
  223. self.insert_device_online()
  224. t = self.do_op(
  225. 'transfer',
  226. 'alice',
  227. f'1:0:{self.burn_addr},{amt}',
  228. no_relay = True,
  229. do_ret = True,
  230. add_opts = add_opts)
  231. t.read() # required!
  232. self.remove_device_online()
  233. return t
  234. def create_transfer_tx1(self):
  235. return self._create_transfer_tx('0.124', add_opts=['--priority=2'])
  236. def create_transfer_tx2(self):
  237. return self._create_transfer_tx('0.257')
  238. create_transfer_tx2a = create_transfer_tx2
  239. def _abort_tx(self,expect,send=None,exit_val=None):
  240. self.insert_device_online()
  241. t = self.spawn('mmgen-xmrwallet', ['--autosign', 'abort'], exit_val=exit_val)
  242. t.expect(expect)
  243. if send:
  244. t.send(send)
  245. t.read() # required!
  246. self.remove_device_online()
  247. return t
  248. def abort_tx1(self):
  249. return self._abort_tx('No unsent transactions present', exit_val=2)
  250. def abort_tx2(self):
  251. return self._abort_tx('(y/N): ', 'y')
  252. def _xmr_autosign_op(
  253. self,
  254. op,
  255. desc = None,
  256. signable_desc = None,
  257. ext = None,
  258. wallet_arg = None,
  259. add_opts = [],
  260. wait_signed = False):
  261. if wait_signed:
  262. self._wait_signed(signable_desc)
  263. data = self.users['alice']
  264. args = (
  265. self.extra_opts
  266. + self.autosign_opts
  267. + [f'--wallet-dir={data.udir}', f'--daemon=localhost:{data.md.rpc_port}']
  268. + add_opts
  269. + [ op ]
  270. + ([get_file_with_ext(self.asi.xmr_tx_dir,ext)] if ext else [])
  271. + ([wallet_arg] if wallet_arg else [])
  272. )
  273. desc_pfx = f'{desc}, ' if desc else ''
  274. self.insert_device_online() # device must be removed by calling method
  275. return self.spawn( 'mmgen-xmrwallet', args, extra_desc=f'({desc_pfx}Alice)' )
  276. def _sync_chkbal(self,wallet_arg,bal_chk_func):
  277. return self.sync_wallets(
  278. 'alice',
  279. op = 'sync',
  280. wallets = wallet_arg,
  281. bal_chk_func = bal_chk_func )
  282. def sync_chkbal1(self):
  283. return self._sync_chkbal( '1', lambda n,b,ub: b == ub and 1 < b < 1.12 )
  284. # 1.234567891234 - 0.124 = 1.110567891234 (minus fees)
  285. def sync_chkbal2(self):
  286. return self._sync_chkbal( '1', lambda n,b,ub: b == ub and 0.8 < b < 0.86 )
  287. # 1.234567891234 - 0.124 - 0.257 = 0.853567891234 (minus fees)
  288. def sync_chkbal3(self):
  289. return self._sync_chkbal(
  290. '1-2',
  291. lambda n,b,ub: b == ub and ((n == 1 and 0.8 < b < 0.86) or (n == 2 and b > 1.23)) )
  292. def _mine_chk(self,desc):
  293. bal_type = {'locked':'b','unlocked':'ub'}[desc]
  294. return self.mine_chk(
  295. 'alice', 1, 0,
  296. lambda x: 0 < getattr(x,bal_type) < 1.234567891234,
  297. f'{desc} balance 0 < 1.234567891234' )
  298. def submit_transfer_tx1(self):
  299. return self._submit_transfer_tx()
  300. def resubmit_transfer_tx1(self):
  301. return self._submit_transfer_tx(
  302. relay_parm = self.tx_relay_daemon_proxy_parm,
  303. op = 'resubmit',
  304. check_bal = False)
  305. def submit_transfer_tx2(self):
  306. return self._submit_transfer_tx( relay_parm=self.tx_relay_daemon_parm )
  307. def _submit_transfer_tx(self,relay_parm=None,ext=None,op='submit',check_bal=True):
  308. t = self._xmr_autosign_op(
  309. op = op,
  310. add_opts = [f'--tx-relay-daemon={relay_parm}'] if relay_parm else [],
  311. ext = ext,
  312. signable_desc = 'transaction',
  313. wait_signed = op == 'submit')
  314. t.expect( f'{op.capitalize()} transaction? (y/N): ', 'y' )
  315. t.written_to_file('Submitted transaction')
  316. t.read()
  317. self.remove_device_online() # device was inserted by _xmr_autosign_op()
  318. if check_bal:
  319. t.ok()
  320. return self._mine_chk('unlocked')
  321. else:
  322. return t
  323. def _export_outputs(self, wallet_arg, op, add_opts=[]):
  324. t = self._xmr_autosign_op(
  325. op = op,
  326. wallet_arg = wallet_arg,
  327. add_opts = add_opts)
  328. t.written_to_file('Wallet outputs')
  329. t.read()
  330. self.remove_device_online() # device was inserted by _xmr_autosign_op()
  331. return t
  332. def export_outputs1(self):
  333. return self._export_outputs('1', op='export-outputs')
  334. def export_outputs2(self): # NB: --rescan-spent does not work with testnet/stagenet
  335. return self._export_outputs('1', op='export-outputs-sign', add_opts=['--rescan-blockchain'])
  336. def export_outputs3(self):
  337. return self._export_outputs('1-2', op='export-outputs-sign')
  338. def _import_key_images(self,wallet_arg):
  339. t = self._xmr_autosign_op(
  340. op = 'import-key-images',
  341. wallet_arg = wallet_arg,
  342. signable_desc = 'wallet outputs',
  343. wait_signed = True)
  344. t.read()
  345. self.remove_device_online() # device was inserted by _xmr_autosign_op()
  346. return t
  347. def import_key_images1(self):
  348. return self._import_key_images(None)
  349. def import_key_images2(self):
  350. return self._import_key_images(None)
  351. def txlist(self):
  352. self.insert_device_online()
  353. t = self.spawn( 'mmgen-xmrwallet', self.autosign_opts + ['txlist'] )
  354. t.match_expect_list([
  355. 'SUBMITTED',
  356. 'Network','Submitted',
  357. 'transfer 1:0','-> ext',
  358. 'transfer 1:0','-> ext'
  359. ])
  360. t.read()
  361. self.remove_device_online()
  362. return t
  363. def txview(self):
  364. self.insert_device_online()
  365. t = self.spawn('mmgen-xmrwallet', self.autosign_opts + ['txview'])
  366. t.read()
  367. self.remove_device_online()
  368. return t
  369. def txview_all(self):
  370. t = self.spawn('', msg_only=True)
  371. self.insert_device()
  372. self.do_mount()
  373. imsg(blue('Opening transaction directory: ') + cyan(f'{self.asi.xmr_tx_dir}'))
  374. for fn in self.asi.xmr_tx_dir.iterdir():
  375. imsg('\n' + brown(f'Viewing ‘{fn.name}’'))
  376. self.spawn('mmgen-xmrwallet', ['txview', str(fn)], no_msg=True).read()
  377. imsg('')
  378. self.do_umount()
  379. self.remove_device()
  380. return 'ok'
  381. def check_tx_dirs(self):
  382. self.insert_device()
  383. self.do_mount()
  384. before = '\n'.join(self._gen_listing())
  385. self.do_umount()
  386. self.remove_device()
  387. self.insert_device()
  388. t = self.spawn('mmgen-autosign', self.opts + ['clean'])
  389. t.read()
  390. self.remove_device()
  391. self.insert_device()
  392. self.do_mount()
  393. after = '\n'.join(self._gen_listing())
  394. self.do_umount()
  395. self.remove_device()
  396. imsg(f'\nBefore cleaning:\n{before}')
  397. imsg(f'\nAfter cleaning:\n{after}')
  398. pat = r'xmr/tx: \s*\S+\.subtx \S+\.subtx\s+xmr/outputs:\s*$'
  399. assert re.search( pat, after, re.DOTALL ), f'regex search for {pat} failed'
  400. return t
  401. def view(self):
  402. return self.sync_wallets('alice', op='view', wallets='1')
  403. def listview(self):
  404. return self.sync_wallets('alice', op='listview', wallets='2')