xmrwallet.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845
  1. #!/usr/bin/env python3
  2. #
  3. # MMGen Wallet, a terminal-based cryptocurrency wallet
  4. # Copyright (C)2013-2025 The MMGen Project <mmgen@tuta.io>
  5. #
  6. # This program is free software: you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License as published by
  8. # the Free Software Foundation, either version 3 of the License, or
  9. # (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18. """
  19. test.cmdtest_d.xmrwallet: xmrwallet tests for the cmdtest.py test suite
  20. """
  21. import sys, os, time, re, atexit, asyncio, shutil
  22. from subprocess import run, PIPE
  23. from collections import namedtuple
  24. from mmgen.util import capfirst, is_int, die, list_gen
  25. from mmgen.obj import MMGenRange
  26. from mmgen.amt import XMRAmt
  27. from mmgen.addrlist import ViewKeyAddrList, KeyAddrList, AddrIdxList
  28. from ..include.common import (
  29. omsg,
  30. oqmsg_r,
  31. ok,
  32. imsg,
  33. imsg_r,
  34. write_data_to_file,
  35. read_from_file,
  36. silence,
  37. end_silence,
  38. strip_ansi_escapes
  39. )
  40. from .include.common import get_file_with_ext
  41. from .include.proxy import TestProxy
  42. from .base import CmdTestBase
  43. # atexit functions:
  44. def stop_daemons(self):
  45. for v in self.users.values():
  46. v.md.stop()
  47. def stop_miner_wallet_daemon(self):
  48. asyncio.run(self.users['miner'].wd_rpc.stop_daemon())
  49. class CmdTestXMRWallet(CmdTestBase):
  50. """
  51. Monero wallet operations
  52. """
  53. networks = ('xmr',)
  54. tmpdir_nums = [29]
  55. dfl_random_txs = 3
  56. color = True
  57. # Bob’s daemon is stopped via process kill, not RPC, so put Bob last in list:
  58. # user sid autosign shift kal_range add_coind_args
  59. user_data = (
  60. ('miner', '98831F3A', False, 130, '1-2', []),
  61. ('alice', 'FE3C6545', False, 150, '1-4', []),
  62. ('bob', '1378FC64', False, 140, None, ['--restricted-rpc']),
  63. )
  64. tx_relay_user = 'bob'
  65. daemon_datadir_base = os.path.join('test', 'daemons', 'xmrtest')
  66. compat = False
  67. cmd_group = (
  68. ('daemon_version', 'checking daemon version'),
  69. ('gen_kafiles_miner_alice', 'generating key-address files for Miner and Alice'),
  70. ('create_wallets_miner', 'creating Monero wallets (Miner)'),
  71. ('set_label_miner', 'setting an address label (Miner, primary account)'),
  72. ('mine_initial_coins', 'mining initial coins'),
  73. ('create_wallets_alice', 'creating Monero wallets (Alice)'),
  74. ('fund_alice', 'sending funds'),
  75. ('check_bal_alice', 'mining, checking balance'),
  76. ('sync_wallets_all', 'syncing all wallets'),
  77. ('new_account_alice', 'creating a new account (Alice)'),
  78. ('new_account_alice_label', 'creating a new account (Alice, with label)'),
  79. ('new_address_alice', 'creating a new address (Alice)'),
  80. ('new_address_alice_label', 'creating a new address (Alice, with label)'),
  81. ('remove_label_alice', 'removing an address label (Alice, subaddress)'),
  82. ('set_label_alice', 'setting an address label (Alice, subaddress)'),
  83. ('sync_wallets_selected', 'syncing selected wallets'),
  84. ('sweep_to_wallet', 'sweeping to new account in another wallet'),
  85. ('sweep_to_account', 'sweeping to specific account in same wallet'),
  86. ('sweep_to_wallet_account', 'sweeping to specific account in another wallet'),
  87. ('sweep_to_wallet_account_proxy', 'sweeping to specific account in another wallet (via TX relay + proxy)'),
  88. ('sweep_to_same_account_noproxy', 'sweeping to same account (via TX relay, no proxy)'),
  89. ('transfer_to_miner_proxy', 'transferring funds to Miner (via TX relay + proxy)'),
  90. ('transfer_to_miner_noproxy', 'transferring funds to Miner (via TX relay, no proxy)'),
  91. ('transfer_to_miner_create1', 'transferring funds to Miner (create TX)'),
  92. ('transfer_to_miner_send1', 'transferring funds to Miner (send TX via proxy)'),
  93. ('transfer_to_miner_create2', 'transferring funds to Miner (create TX)'),
  94. ('transfer_to_miner_send2', 'transferring funds to Miner (send TX, no proxy)'),
  95. ('sweep_create_and_send', 'sweeping to new account (create TX + send TX, in stages)'),
  96. ('list_wallets_all', 'listing wallets'),
  97. ('stop_daemons', 'stopping all wallet and coin daemons'),
  98. )
  99. def __init__(self, cfg, trunner, cfgs, spawn):
  100. CmdTestBase.__init__(self, cfg, trunner, cfgs, spawn)
  101. if trunner is None:
  102. return
  103. from mmgen.protocol import init_proto
  104. self.proto = init_proto(cfg, 'XMR', network='mainnet')
  105. self.extra_opts = ['--wallet-rpc-password=passw0rd']
  106. self.init_users()
  107. self.init_daemon_args()
  108. for v in self.users.values():
  109. run(['mkdir', '-p', v.udir])
  110. self.tx_relay_daemon_parm = 'localhost:{}'.format(self.users[self.tx_relay_user].md.rpc_port)
  111. self.tx_relay_daemon_proxy_parm = (
  112. # must be IP, not 'localhost':
  113. self.tx_relay_daemon_parm + f':127.0.0.1:{TestProxy.port}')
  114. if not cfg.no_daemon_stop:
  115. atexit.register(stop_daemons, self)
  116. atexit.register(stop_miner_wallet_daemon, self)
  117. if not cfg.no_daemon_autostart:
  118. stop_daemons(self)
  119. time.sleep(0.2)
  120. if os.path.exists(self.daemon_datadir_base):
  121. shutil.rmtree(self.daemon_datadir_base)
  122. os.makedirs(self.daemon_datadir_base)
  123. TestProxy(self, cfg)
  124. self.start_daemons()
  125. self.balance = None
  126. # init methods
  127. def init_users(self):
  128. from mmgen.daemon import CoinDaemon
  129. from mmgen.proto.xmr.daemon import MoneroWalletDaemon
  130. from mmgen.proto.xmr.rpc import MoneroRPCClient, MoneroWalletRPCClient
  131. self.users = {}
  132. tmpdir_num = self.tmpdir_nums[0]
  133. ud = namedtuple('user_data', [
  134. 'sid',
  135. 'mmwords',
  136. 'autosign',
  137. 'udir',
  138. 'daemon_datadir',
  139. 'kal_range',
  140. 'kafile',
  141. 'walletfile_fs',
  142. 'addrfile_fs',
  143. 'md',
  144. 'md_rpc',
  145. 'wd',
  146. 'wd_rpc',
  147. 'add_coind_args',
  148. ])
  149. # kal_range must be None, a single digit, or a single hyphenated range
  150. for (
  151. user,
  152. sid,
  153. autosign,
  154. shift,
  155. kal_range,
  156. add_coind_args) in self.user_data:
  157. tmpdir = os.path.join('test', 'tmp', str(tmpdir_num))
  158. udir = os.path.join(tmpdir, user)
  159. daemon_datadir = os.path.join(self.daemon_datadir_base, user)
  160. if self.compat:
  161. from mmgen.tw.ctl import TwCtl
  162. twctl_cls = self.proto.base_proto_subclass(TwCtl, 'tw.ctl')
  163. wallet_dir = os.path.join(self.tr.data_dir, user, 'altcoins', 'xmr', twctl_cls.tw_subdir)
  164. else:
  165. wallet_dir = udir
  166. md = CoinDaemon(
  167. cfg = self.cfg,
  168. proto = self.proto,
  169. test_suite = True,
  170. port_shift = shift,
  171. opts = ['online'],
  172. datadir = daemon_datadir
  173. )
  174. md_rpc = MoneroRPCClient(
  175. cfg = self.cfg,
  176. proto = self.proto,
  177. host = 'localhost',
  178. port = md.rpc_port,
  179. user = None,
  180. passwd = None,
  181. test_connection = False,
  182. daemon = md,
  183. )
  184. wd = MoneroWalletDaemon(
  185. cfg = self.cfg,
  186. proto = self.proto,
  187. test_suite = True,
  188. wallet_dir = wallet_dir,
  189. user = 'foo',
  190. passwd = 'bar',
  191. port_shift = shift,
  192. monerod_addr = f'127.0.0.1:{md.rpc_port}',
  193. )
  194. wd_rpc = MoneroWalletRPCClient(
  195. cfg = self.cfg,
  196. daemon = wd,
  197. test_connection = False,
  198. )
  199. if autosign:
  200. kafile_suf = 'vkeys'
  201. fn_stem = 'MoneroWatchOnlyWallet'
  202. kafile_dir = self.asi_online.xmr_dir
  203. else:
  204. kafile_suf = 'akeys'
  205. fn_stem = 'MoneroWallet'
  206. kafile_dir = udir
  207. self.users[user] = ud(
  208. sid = sid,
  209. mmwords = f'test/ref/{sid}.mmwords',
  210. autosign = autosign,
  211. udir = udir,
  212. daemon_datadir = daemon_datadir,
  213. kal_range = kal_range,
  214. kafile = f'{kafile_dir}/{sid}-XMR-M[{kal_range}].{kafile_suf}',
  215. walletfile_fs = f'{udir}/{sid}-{{}}-{fn_stem}',
  216. addrfile_fs = f'{udir}/{sid}-{{}}-{fn_stem}.address.txt',
  217. md = md,
  218. md_rpc = md_rpc,
  219. wd = wd,
  220. wd_rpc = wd_rpc,
  221. add_coind_args = add_coind_args)
  222. def init_daemon_args(self):
  223. common_args = ['--p2p-bind-ip=127.0.0.1', '--fixed-difficulty=1', '--regtest'] # --rpc-ssl-allow-any-cert
  224. for u in self.users:
  225. other_ports = [self.users[u2].md.p2p_port for u2 in self.users if u2 != u]
  226. node_args = [f'--add-exclusive-node=127.0.0.1:{p}' for p in other_ports]
  227. self.users[u].md.usr_coind_args = (
  228. common_args
  229. + node_args
  230. + self.users[u].add_coind_args)
  231. # cmd_group methods
  232. def daemon_version(self):
  233. rpc_port = self.users['miner'].md.rpc_port
  234. return self.spawn('mmgen-tool', ['--coin=xmr', f'--rpc-port={rpc_port}', 'daemon_version'])
  235. def gen_kafiles_miner_alice(self):
  236. return self.gen_kafiles(['miner', 'alice'])
  237. def gen_kafiles(self, users):
  238. for user, data in self.users.items():
  239. if not user in users:
  240. continue
  241. run(['mkdir', '-p', data.udir])
  242. run(f'rm -f {data.kafile}', shell=True)
  243. t = self.spawn(
  244. 'mmgen-keygen', [
  245. '-q', '--accept-defaults', '--coin=xmr',
  246. f'--outdir={data.udir}', data.mmwords, data.kal_range
  247. ],
  248. extra_desc = f'({capfirst(user)})')
  249. t.read()
  250. t.ok()
  251. t.skip_ok = True
  252. return t
  253. def create_wallets_miner(self):
  254. return self.create_wallets('miner')
  255. def create_wallets_alice(self):
  256. return self.create_wallets('alice')
  257. def create_wallets(self, user, wallet=None, add_opts=[], op='create'):
  258. assert wallet is None or is_int(wallet), 'wallet arg'
  259. data = self.users[user]
  260. stem_glob = data.walletfile_fs.format(wallet or '*')
  261. for glob in (
  262. stem_glob,
  263. stem_glob + '.keys',
  264. stem_glob + '.address.txt'):
  265. run(f'rm -f {glob}', shell=True)
  266. t = self.spawn(
  267. 'mmgen-xmrwallet',
  268. self.extra_opts
  269. + ([f'--{user}', '--compat'] if self.compat else [f'--wallet-dir={data.udir}'])
  270. + (self.autosign_opts if data.autosign else [])
  271. + add_opts
  272. + [op]
  273. + ([] if data.autosign else [data.kafile])
  274. + [wallet or data.kal_range])
  275. for i in MMGenRange(wallet or data.kal_range).items:
  276. write_data_to_file(
  277. self.cfg,
  278. self.users[user].addrfile_fs.format(i),
  279. t.expect_getend('Address: '),
  280. quiet = True)
  281. return t
  282. def new_addr_alice(self, spec, cfg, expect, kafile=None):
  283. data = self.users['alice']
  284. t = self.spawn(
  285. 'mmgen-xmrwallet',
  286. self.extra_opts
  287. + (['--alice', '--compat'] if self.compat else [f'--wallet-dir={data.udir}'])
  288. + [f'--daemon=localhost:{data.md.rpc_port}']
  289. + (['--no-start-wallet-daemon'] if cfg in ('continue', 'stop') else [])
  290. + (['--no-stop-wallet-daemon'] if cfg in ('start', 'continue') else [])
  291. + ['new', (kafile or data.kafile), spec])
  292. t.expect(expect, 'y', regex=True)
  293. return t
  294. na_idx = 1
  295. def new_account_alice(self):
  296. return self.new_addr_alice(
  297. '4',
  298. 'start',
  299. r'Creating new account for wallet .*4.* with label .*‘xmrwallet new account .*y/N\): ')
  300. def new_account_alice_label(self):
  301. return self.new_addr_alice(
  302. '4,Alice’s new account',
  303. 'continue',
  304. r'Creating new account for wallet .*4.* with label .*‘Alice’s new account .*y/N\): ')
  305. def new_address_alice(self):
  306. return self.new_addr_alice(
  307. '4:2',
  308. 'continue',
  309. r'Creating new address for wallet .*4.*, account .*#2.* with label .*‘xmrwallet new address .*y/N\): ')
  310. def new_address_alice_label(self):
  311. return self.new_addr_alice(
  312. '4:2,Alice’s new address',
  313. 'stop',
  314. r'Creating new address for wallet .*4.*, account .*#2.* with label .*‘Alice’s new address .*y/N\): ')
  315. async def mine_initial_coins(self):
  316. self.spawn(msg_only=True, extra_desc='(opening wallet)')
  317. await self.open_wallet_user('miner', 1)
  318. ok()
  319. # NB: a large balance is required to avoid ‘insufficient outputs’ error
  320. return await self.mine_chk('miner', 1, 0, lambda x: x.ub > 2000, 'unlocked balance > 2000')
  321. async def fund_alice(self, wallet=1, amt=1234567891234):
  322. self.spawn(msg_only=True, extra_desc='(transferring funds from Miner wallet)')
  323. await self.transfer(
  324. 'miner',
  325. amt,
  326. read_from_file(self.users['alice'].addrfile_fs.format(wallet)))
  327. return 'ok'
  328. async def check_bal_alice(self, wallet=1, bal='1.234567891234'):
  329. return await self.mine_chk(
  330. 'alice', wallet, 0,
  331. lambda x: str(x.ub) == bal, f'unlocked balance == {bal}',
  332. random_txs = self.dfl_random_txs)
  333. def set_label_miner(self):
  334. return self.set_label_user(
  335. 'miner',
  336. '1:0:0,"Miner’s new primary account label [1:0:0]"',
  337. 'updated')
  338. def remove_label_alice(self):
  339. return self.set_label_user(
  340. 'alice',
  341. '4:2:2,""',
  342. 'removed',
  343. add_opts = ['--full-address'])
  344. def set_label_alice(self):
  345. return self.set_label_user(
  346. 'alice',
  347. '4:2:2,"Alice’s new subaddress label [4:2:2]"',
  348. 'set')
  349. def set_label_user(self, user, label_spec, expect, add_opts=[]):
  350. data = self.users[user]
  351. cmd_opts = [f'--wallet-dir={data.udir}', f'--daemon=localhost:{data.md.rpc_port}']
  352. t = self.spawn(
  353. 'mmgen-xmrwallet',
  354. self.extra_opts
  355. + add_opts
  356. + cmd_opts
  357. + ['label', data.kafile, label_spec])
  358. t.expect('(y/N): ', 'y')
  359. t.expect(f'Label successfully {expect}')
  360. return t
  361. def sync_wallets_all(self):
  362. return self.sync_wallets('alice', add_opts=['--rescan-blockchain', '-Ee'])
  363. def sync_wallets_selected(self):
  364. return self.sync_wallets('alice', wallets='1-2,4', add_opts=['--full-address'])
  365. def list_wallets_all(self):
  366. return self.sync_wallets('alice', op='list', add_opts=['-Ee', '--full-address'])
  367. def sync_wallets_alice(self):
  368. return self.sync_wallets('alice')
  369. def sync_wallets_bob(self):
  370. return self.sync_wallets('bob')
  371. def sync_wallets_miner(self):
  372. return self.sync_wallets('miner')
  373. def sync_wallets(self, user, op='sync', wallets=None, add_opts=[], bal_chk_func=None):
  374. data = self.users[user]
  375. if data.autosign:
  376. self.insert_device_online()
  377. t = self.spawn(
  378. 'mmgen-xmrwallet',
  379. self.extra_opts
  380. + ([f'--{user}', '--compat'] if self.compat else [f'--wallet-dir={data.udir}'])
  381. + [f'--daemon=localhost:{data.md.rpc_port}']
  382. + (self.autosign_opts if data.autosign else [])
  383. + add_opts
  384. + [op]
  385. + ([] if data.autosign else [data.kafile])
  386. + ([wallets] if wallets else []))
  387. wlist = AddrIdxList(fmt_str=wallets) if wallets else MMGenRange(data.kal_range).items
  388. for n, wnum in enumerate(wlist, 1):
  389. t.expect('ing wallet {}/{} ({})'.format(
  390. n,
  391. len(wlist),
  392. os.path.basename(data.walletfile_fs.format(wnum))))
  393. if op in ('view', 'listview'):
  394. t.expect('Wallet height: ')
  395. else:
  396. t.expect('Chain height: ')
  397. t.expect('Wallet height: ')
  398. res = strip_ansi_escapes(t.expect_getend('Balance: '))
  399. if bal_chk_func:
  400. m = re.match(r'(\S+) Unlocked balance: (\S+)', res, re.DOTALL)
  401. amts = [XMRAmt(amt) for amt in m.groups()]
  402. assert bal_chk_func(n, *amts), f'balance check for wallet {n} failed!'
  403. if data.autosign:
  404. t.read()
  405. self.remove_device_online()
  406. return t
  407. def do_op(
  408. self,
  409. op,
  410. user,
  411. arg2,
  412. tx_relay_parm = None,
  413. no_relay = False,
  414. use_existing = False,
  415. add_opts = [],
  416. add_desc = None,
  417. do_ret = False):
  418. data = self.users[user]
  419. cmd_opts = list_gen(
  420. [f'--outdir={data.udir}', not data.autosign],
  421. [f'--daemon=localhost:{data.md.rpc_port}'],
  422. [f'--tx-relay-daemon={tx_relay_parm}', tx_relay_parm],
  423. ['--no-relay', no_relay and not data.autosign])
  424. add_desc = (', ' + add_desc) if add_desc else ''
  425. t = self.spawn(
  426. 'mmgen-xmrwallet',
  427. self.extra_opts
  428. + ([f'--{user}', '--compat'] if self.compat else [f'--wallet-dir={data.udir}'])
  429. + cmd_opts
  430. + add_opts
  431. + (self.autosign_opts if data.autosign else [])
  432. + [op]
  433. + ([] if data.autosign else [data.kafile])
  434. + [arg2],
  435. extra_desc = f'({capfirst(user)}{add_desc})')
  436. if op == 'sign':
  437. return t
  438. if op in ('sweep', 'sweep_all'):
  439. desc = 'address' if re.match(r'.*:\d+$', arg2) else 'account'
  440. t.expect(rf'Create new {desc} .* \(y/N\): ', ('y', 'n')[use_existing], regex=True)
  441. if use_existing:
  442. t.expect(rf'to last existing {desc} .* \(y/N\): ', 'y', regex=True)
  443. dtype = 'unsigned' if data.autosign else 'signed'
  444. t.expect(f'Save {dtype} transaction? (y/N): ', 'y')
  445. t.written_to_file(f'{dtype.capitalize()} transaction')
  446. if not no_relay:
  447. t.expect(f'Relay {op} transaction? (y/N): ', 'y')
  448. get_file_with_ext(self.users[user].udir, 'sigtx', delete_all=True)
  449. t.read()
  450. return t if do_ret else t.ok()
  451. async def sweep_to_wallet(self):
  452. self.do_op('sweep', 'alice', '1:0,2')
  453. return await self.mine_chk('alice', 2, 1, lambda x: x.ub > 1, 'unlocked balance > 1')
  454. async def sweep_to_account(self):
  455. self.do_op('sweep', 'alice', '2:1,2:0', use_existing=True)
  456. return await self.mine_chk('alice', 2, 0, lambda x: x.ub > 1, 'unlocked balance > 1')
  457. async def sweep_to_wallet_account(self):
  458. self.do_op('sweep', 'alice', '2:0,3:0', use_existing=True, add_opts=['-Ee', '--full-address'])
  459. return await self.mine_chk('alice', 3, 0, lambda x: x.ub > 1, 'unlocked balance > 1')
  460. async def sweep_to_wallet_account_proxy(self):
  461. self.do_op('sweep', 'alice', '3:0,2:1', self.tx_relay_daemon_proxy_parm, add_opts=['--priority=3', '-Ee'])
  462. return await self.mine_chk('alice', 2, 1, lambda x: x.ub > 1, 'unlocked balance > 1')
  463. async def sweep_to_same_account_noproxy(self):
  464. self.do_op('sweep', 'alice', '2:1', self.tx_relay_daemon_parm)
  465. return await self.mine_chk('alice', 2, 1, lambda x: x.ub > 0.9, 'unlocked balance > 0.9')
  466. async def transfer_to_miner_proxy(self):
  467. addr = read_from_file(self.users['miner'].addrfile_fs.format(2))
  468. amt = '0.135'
  469. self.do_op('transfer', 'alice', f'2:1:{addr},{amt}', self.tx_relay_daemon_proxy_parm)
  470. await self.stop_wallet_user('miner')
  471. await self.open_wallet_user('miner', 2)
  472. await self.mine_chk('miner', 2, 0, lambda x: str(x.ub) == amt, f'unlocked balance == {amt}')
  473. ok()
  474. return await self.mine_chk('alice', 2, 1, lambda x: x.ub > 0.9, 'unlocked balance > 0.9')
  475. async def transfer_to_miner_noproxy(self):
  476. addr = read_from_file(self.users['miner'].addrfile_fs.format(2))
  477. self.do_op('transfer', 'alice', f'2:1:{addr},0.0995', self.tx_relay_daemon_parm, add_opts=['--full-address'])
  478. await self.mine_chk('miner', 2, 0, lambda x: str(x.ub) == '0.2345', 'unlocked balance == 0.2345')
  479. ok()
  480. return await self.mine_chk('alice', 2, 1, lambda x: x.ub > 0.9, 'unlocked balance > 0.9')
  481. def transfer_to_miner_create(self, amt):
  482. get_file_with_ext(self.users['alice'].udir, 'sigtx', delete_all=True)
  483. addr = read_from_file(self.users['miner'].addrfile_fs.format(2))
  484. return self.do_op('transfer', 'alice', f'2:1:{addr},{amt}', no_relay=True, do_ret=True, add_opts=['-Ee'])
  485. def transfer_to_miner_create1(self):
  486. return self.transfer_to_miner_create('0.0111')
  487. def transfer_to_miner_create2(self):
  488. return self.transfer_to_miner_create('0.0012')
  489. def relay_tx(self, relay_opt, add_desc=None):
  490. user = 'alice'
  491. data = self.users[user]
  492. add_desc = (', ' + add_desc) if add_desc else ''
  493. t = self.spawn(
  494. 'mmgen-xmrwallet',
  495. self.extra_opts
  496. + [relay_opt, 'relay', get_file_with_ext(data.udir, 'sigtx')],
  497. extra_desc = f'(relaying TX, {capfirst(user)}{add_desc})')
  498. t.expect('Relay transaction? ', 'y')
  499. t.read()
  500. t.ok()
  501. return t
  502. async def transfer_to_miner_send1(self):
  503. self.relay_tx(f'--tx-relay-daemon={self.tx_relay_daemon_proxy_parm}', add_desc='via proxy')
  504. await self.mine_chk('miner', 2, 0, lambda x: str(x.ub) == '0.2456', 'unlocked balance == 0.2456')
  505. ok()
  506. return await self.mine_chk('alice', 2, 1, lambda x: x.ub > 0.9, 'unlocked balance > 0.9')
  507. async def transfer_to_miner_send2(self):
  508. self.relay_tx(f'--tx-relay-daemon={self.tx_relay_daemon_parm}', add_desc='no proxy')
  509. await self.mine_chk('miner', 2, 0, lambda x: str(x.ub) == '0.2468', 'unlocked balance == 0.2468')
  510. ok()
  511. return await self.mine_chk('alice', 2, 1, lambda x: x.ub > 0.9, 'unlocked balance > 0.9')
  512. async def sweep_create_and_send(self):
  513. get_file_with_ext(self.users['alice'].udir, 'sigtx', delete_all=True)
  514. self.do_op('sweep_all', 'alice', '2:1,3', no_relay=True, use_existing=True)
  515. ok()
  516. self.relay_tx(f'--tx-relay-daemon={self.tx_relay_daemon_parm}')
  517. min_bal = XMRAmt('0.9')
  518. return await self.mine_chk('alice', 3, 0, lambda x: x.ub > min_bal, f'bal > {min_bal}')
  519. # wallet methods
  520. async def open_wallet_user(self, user, wnum):
  521. data = self.users[user]
  522. if data.autosign:
  523. self.insert_device_online()
  524. self.do_mount_online()
  525. silence()
  526. kal = (ViewKeyAddrList if data.autosign else KeyAddrList)(
  527. cfg = self.cfg,
  528. proto = self.proto,
  529. infile = data.kafile,
  530. skip_chksum_msg = True,
  531. key_address_validity_check = False)
  532. end_silence()
  533. if data.autosign:
  534. self.do_umount_online()
  535. self.remove_device_online()
  536. self.users[user].wd.start(silent=self.tr.quiet)
  537. return data.wd_rpc.call(
  538. 'open_wallet',
  539. filename = os.path.basename(data.walletfile_fs.format(wnum)),
  540. password = kal.entry(wnum).wallet_passwd)
  541. async def stop_wallet_user(self, user):
  542. await self.users[user].wd_rpc.stop_daemon(silent=self.tr.quiet)
  543. return 'ok'
  544. # mining methods
  545. async def mine5(self):
  546. return await self.mine(5)
  547. async def _get_height(self):
  548. u = self.users['miner']
  549. for _ in range(20):
  550. try:
  551. return u.md_rpc.call('get_last_block_header')['block_header']['height']
  552. except Exception as e:
  553. if 'onnection refused' in str(e):
  554. omsg(f'{e}\nMonerod appears to have crashed. Attempting to restart...')
  555. await asyncio.sleep(5)
  556. u.md.restart()
  557. await asyncio.sleep(5)
  558. await self.start_mining()
  559. else:
  560. raise
  561. die(2, 'Restart attempt limit exceeded')
  562. async def mine10(self):
  563. return await self.mine(10)
  564. async def mine30(self):
  565. return await self.mine(30)
  566. async def mine100(self):
  567. return await self.mine(100)
  568. async def mine(self, nblks):
  569. start_height = height = await self._get_height()
  570. imsg(f'Height: {height}')
  571. imsg_r(f'Mining {nblks} blocks...')
  572. await self.start_mining()
  573. while height < start_height + nblks:
  574. await asyncio.sleep(2)
  575. height = await self._get_height()
  576. imsg_r('.')
  577. ret = await self.stop_mining()
  578. imsg('done')
  579. imsg(f'Height: {height}')
  580. return 'ok' if ret == 'OK' else False
  581. async def start_mining(self):
  582. data = self.users['miner']
  583. addr = read_from_file(data.addrfile_fs.format(1)) # mine to wallet #1, account 0
  584. for _ in range(20):
  585. # NB: threads_count > 1 provides no benefit and leads to connection errors with MSWin/MSYS2
  586. ret = data.md_rpc.call_raw(
  587. 'start_mining',
  588. do_background_mining = False, # run mining in background or foreground
  589. ignore_battery = True, # ignore battery state (on laptop)
  590. miner_address = addr, # account address to mine to
  591. threads_count = 1) # number of mining threads to run
  592. match self.get_status(ret):
  593. case 'OK':
  594. return True
  595. case 'BUSY':
  596. await asyncio.sleep(5)
  597. omsg('Daemon busy. Attempting to start mining...')
  598. case status:
  599. die(2, f'Monerod returned status {status}')
  600. die(2, 'Max retries exceeded')
  601. async def stop_mining(self):
  602. ret = self.users['miner'].md_rpc.call_raw('stop_mining')
  603. return self.get_status(ret)
  604. async def mine_chk(
  605. self,
  606. user,
  607. wnum,
  608. account,
  609. test,
  610. test_desc,
  611. test2 = None,
  612. test2_desc = None,
  613. random_txs = None,
  614. return_bal = False):
  615. """
  616. - open destination wallet
  617. - optionally create and broadcast random TXs
  618. - start mining
  619. - mine until funds appear in wallet
  620. - stop mining
  621. - close wallet
  622. """
  623. async def send_random_txs():
  624. from mmgen.tool.api import tool_api
  625. t = tool_api(self.cfg)
  626. t.init_coin('XMR', 'mainnet')
  627. t.usr_randchars = 0
  628. imsg_r('Sending random transactions: ')
  629. for i in range(random_txs):
  630. await self.transfer(
  631. 'miner',
  632. 123456789,
  633. t.randpair()[1],
  634. )
  635. imsg_r(f'{i+1} ')
  636. oqmsg_r('+')
  637. await asyncio.sleep(0.5)
  638. imsg('')
  639. def print_balance(dest, bal_info):
  640. imsg('Total balances in {}’s wallet {}, account #{}: {} (total), {} (unlocked)'.format(
  641. capfirst(dest.user),
  642. dest.wnum,
  643. dest.account,
  644. bal_info.b.hl(),
  645. bal_info.ub.hl()))
  646. async def get_balance(dest, count):
  647. data = self.users[dest.user]
  648. data.wd_rpc.call('refresh')
  649. if count and not count % 20:
  650. data.wd_rpc.call('rescan_blockchain')
  651. ret = data.wd_rpc.call('get_accounts')['subaddress_accounts'][dest.account]
  652. d_tup = namedtuple('bal_info', ['b', 'ub'])
  653. return d_tup(
  654. b = XMRAmt(ret['balance'], from_unit='atomic'),
  655. ub = XMRAmt(ret['unlocked_balance'], from_unit='atomic'))
  656. # start execution:
  657. self.do_msg(extra_desc =
  658. (f'sending {random_txs} random TXs, ' if random_txs else '') +
  659. f'mining, checking wallet {user}:{wnum}:{account}')
  660. dest = namedtuple(
  661. 'dest_info', ['user', 'wnum', 'account', 'test', 'test_desc', 'test2', 'test2_desc'])(
  662. user, wnum, account, test, test_desc, test2, test2_desc)
  663. if dest.user != 'miner':
  664. await self.open_wallet_user(dest.user, dest.wnum)
  665. bal_info_start = await get_balance(dest, 0)
  666. chk_bal_chg = dest.test(bal_info_start) == 'chk_bal_chg'
  667. if random_txs:
  668. await send_random_txs()
  669. await self.start_mining()
  670. h = await self._get_height()
  671. imsg_r(f'Chain height: {h} ')
  672. max_iterations, min_height = (300, 64) if sys.platform == 'win32' else (50, 300)
  673. verbose = False
  674. for count in range(max_iterations):
  675. bal_info = await get_balance(dest, count)
  676. if h > min_height:
  677. if dest.test(bal_info) is True or (chk_bal_chg and bal_info.ub != bal_info_start.ub):
  678. imsg('')
  679. oqmsg_r('+')
  680. print_balance(dest, bal_info)
  681. if dest.test2:
  682. assert dest.test2(bal_info) is True, f'test failed: {dest.test2_desc} ({bal_info})'
  683. break
  684. await asyncio.sleep(2)
  685. h = await self._get_height()
  686. if count > 12: # something might have gone wrong, so be more verbose
  687. if not verbose:
  688. imsg('')
  689. imsg_r(f'Height: {h}, ')
  690. print_balance(dest, bal_info)
  691. verbose = True
  692. else:
  693. imsg_r(f'{h} ')
  694. oqmsg_r('+')
  695. else:
  696. die(2, f'Timeout exceeded, balance {bal_info.ub!r}')
  697. await self.stop_mining()
  698. if user != 'miner':
  699. await self.stop_wallet_user(dest.user)
  700. return bal_info if return_bal else 'ok'
  701. # util methods
  702. def get_status(self, ret):
  703. if ret['status'] != 'OK':
  704. imsg('RPC status: {}'.format(ret['status']))
  705. return ret['status']
  706. def do_msg(self, extra_desc=None):
  707. self.spawn(msg_only=True, extra_desc=f'({extra_desc})' if extra_desc else None)
  708. async def transfer(self, user, amt, addr):
  709. return self.users[user].wd_rpc.call('transfer', destinations=[{'amount':amt, 'address':addr}])
  710. # daemon start/stop methods
  711. def start_daemons(self):
  712. for v in self.users.values():
  713. run(['mkdir', '-p', v.daemon_datadir])
  714. v.md.start()
  715. def stop_daemons(self):
  716. self.spawn(msg_only=True)
  717. if self.cfg.no_daemon_stop:
  718. omsg('[not stopping daemons at user request]')
  719. else:
  720. omsg('')
  721. stop_daemons(self)
  722. atexit.unregister(stop_daemons)
  723. stop_miner_wallet_daemon(self)
  724. atexit.unregister(stop_miner_wallet_daemon)
  725. return 'silent'