ts_shared.py 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2023 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.test_py_d.ts_shared: Shared methods for the test.py test suite
  20. """
  21. import os
  22. from mmgen.util import ymsg
  23. from mmgen.wallet import get_wallet_cls
  24. from ..include.common import *
  25. from .common import *
  26. class TestSuiteShared(object):
  27. 'shared methods for the test.py test suite'
  28. def txcreate_ui_common(self,t,
  29. caller = None,
  30. menu = [],
  31. inputs = '1',
  32. file_desc = 'Unsigned transaction',
  33. input_sels_prompt = 'to spend',
  34. bad_input_sels = False,
  35. interactive_fee = '',
  36. fee_desc = 'transaction fee',
  37. fee_res = None,
  38. eth_fee_res = None,
  39. add_comment = '',
  40. view = 't',
  41. save = True,
  42. tweaks = [],
  43. used_chg_addr_resp = None,
  44. auto_chg_addr = None ):
  45. txdo = (caller or self.test_name)[:4] == 'txdo'
  46. expect_pat = r'\[q\]uit menu, .*?:.'
  47. delete_pat = r'Enter account number .*:.'
  48. confirm_pat = r'Is this what you want.*:.'
  49. if used_chg_addr_resp is not None:
  50. t.expect('reuse harms your privacy.*:.*',used_chg_addr_resp,regex=True)
  51. if auto_chg_addr is not None:
  52. e1 = 'Choose a change address:.*Enter a number> '
  53. e2 = fr'Using .*{auto_chg_addr}.* as.*address'
  54. res = t.expect([e1,e2],regex=True)
  55. if res == 0:
  56. choice = [s.split(')')[0].lstrip() for s in t.p.match[0].split('\n') if auto_chg_addr in s][0]
  57. t.send(f'{choice}\n')
  58. t.expect(e2,regex=True)
  59. t.send('y')
  60. pat = expect_pat
  61. for choice in menu + ['q']:
  62. t.expect(pat,choice,regex=True)
  63. if self.proto.base_proto == 'Ethereum':
  64. pat = confirm_pat if pat == delete_pat else delete_pat if choice == 'D' else expect_pat
  65. if bad_input_sels:
  66. for r in ('x','3-1','9999'):
  67. t.expect(input_sels_prompt+': ',r+'\n')
  68. t.expect(input_sels_prompt+': ',inputs+'\n')
  69. have_est_fee = t.expect([fee_desc+': ','OK? (Y/n): ']) == 1
  70. if have_est_fee and not interactive_fee:
  71. t.send('y')
  72. else:
  73. if have_est_fee:
  74. t.send('n')
  75. if eth_fee_res:
  76. t.expect('or gas price: ',interactive_fee+'\n')
  77. elif have_est_fee and self.proto.base_coin != 'ETH':
  78. t.expect('fee: ',interactive_fee+'\n')
  79. else:
  80. t.send(interactive_fee+'\n')
  81. if fee_res:
  82. t.expect(fee_res,regex=True)
  83. t.expect('OK? (Y/n): ','y')
  84. t.expect('(Y/n): ','\n') # chg amt OK?
  85. if 'confirm_non_mmgen' in tweaks:
  86. t.expect('Continue? (Y/n)','\n')
  87. t.do_comment(add_comment)
  88. t.view_tx(view)
  89. if not txdo:
  90. t.expect('(y/N): ',('n','y')[save])
  91. t.written_to_file(file_desc)
  92. return t
  93. def txsign_ui_common(self,t,
  94. caller = None,
  95. view = 't',
  96. add_comment = '',
  97. file_desc = 'Signed transaction',
  98. ni = False,
  99. save = True,
  100. do_passwd = False,
  101. has_label = False ):
  102. txdo = (caller or self.test_name)[:4] == 'txdo'
  103. if do_passwd:
  104. t.passphrase('MMGen wallet',self.wpasswd)
  105. if not ni and not txdo:
  106. t.view_tx(view)
  107. t.do_comment(add_comment,has_label=has_label)
  108. t.expect('(Y/n): ',('n','y')[save])
  109. t.written_to_file(file_desc)
  110. return t
  111. def txsend_ui_common(self,t,
  112. caller = None,
  113. view = 'n',
  114. add_comment = '',
  115. file_desc = 'Sent transaction',
  116. confirm_send = True,
  117. bogus_send = True,
  118. quiet = False,
  119. has_label = False ):
  120. txdo = (caller or self.test_name)[:4] == 'txdo'
  121. if not txdo:
  122. t.license() # MMGEN_NO_LICENSE is set, so does nothing
  123. t.view_tx(view)
  124. t.do_comment(add_comment,has_label=has_label)
  125. self._do_confirm_send(t,quiet=quiet,confirm_send=confirm_send)
  126. if bogus_send:
  127. txid = ''
  128. t.expect('BOGUS transaction NOT sent')
  129. else:
  130. txid = strip_ansi_escapes(t.expect_getend('Transaction sent: '))
  131. assert len(txid) == 64, f'{txid!r}: Incorrect txid length!'
  132. t.written_to_file(file_desc)
  133. return txid
  134. def txsign_end(self,t,tnum=None,has_label=False):
  135. t.expect('Signing transaction')
  136. t.do_comment(False,has_label=has_label)
  137. t.expect(r'Save signed transaction.*?\? \(Y/n\): ','y',regex=True)
  138. t.written_to_file('Signed transaction' + (' #' + tnum if tnum else ''), oo=True)
  139. return t
  140. def txsign(self,wf,txfile,
  141. pf = '',
  142. bumpf = '',
  143. save = True,
  144. has_label = False,
  145. extra_opts = [],
  146. extra_desc = '',
  147. view = 'n',
  148. dfl_wallet = False ):
  149. opts = extra_opts + ['-d',self.tmpdir,txfile] + ([wf] if wf else [])
  150. t = self.spawn('mmgen-txsign', opts, extra_desc)
  151. t.license()
  152. t.view_tx(view)
  153. wcls = get_wallet_cls( ext = 'mmdat' if dfl_wallet else get_extension(wf) )
  154. if wcls.enc and wcls.type != 'brain':
  155. t.passphrase(wcls.desc,self.wpasswd)
  156. if save:
  157. self.txsign_end(t,has_label=has_label)
  158. else:
  159. t.do_comment(False,has_label=has_label)
  160. t.expect('Save signed transaction? (Y/n): ','n')
  161. t.expect('not saved')
  162. t.req_exit_val = 1
  163. return t
  164. def ref_brain_chk(self,bw_file=ref_bw_file):
  165. wf = joinpath(ref_dir,bw_file)
  166. add_args = [f'-l{self.seed_len}', f'-p{ref_bw_hash_preset}']
  167. return self.walletchk(wf,pf=None,add_args=add_args,sid=self.ref_bw_seed_id)
  168. def walletchk(self,wf,pf,wcls=None,add_args=[],sid=None,extra_desc='',dfl_wallet=False):
  169. hp = self.hash_preset if hasattr(self,'hash_preset') else '1'
  170. wcls = wcls or get_wallet_cls(ext=get_extension(wf))
  171. t = self.spawn('mmgen-walletchk',
  172. ([] if dfl_wallet else ['-i',wcls.fmt_codes[0]])
  173. + add_args + ['-p',hp]
  174. + ([wf] if wf else []),
  175. extra_desc=extra_desc)
  176. if wcls.type != 'incog_hidden':
  177. t.expect(f"Getting {wcls.desc} from file '")
  178. if wcls.enc and wcls.type != 'brain':
  179. t.passphrase(wcls.desc,self.wpasswd)
  180. t.expect(['Passphrase is OK', 'Passphrase.* are correct'],regex=True)
  181. chk = t.expect_getend(f'Valid {wcls.desc} for Seed ID ')[:8]
  182. if sid:
  183. cmp_or_die(chk,sid)
  184. return t
  185. def addrgen(self,wf,
  186. pf = None,
  187. check_ref = False,
  188. ftype = 'addr',
  189. id_str = None,
  190. extra_args = [],
  191. mmtype = None,
  192. stdout = False,
  193. dfl_wallet = False ):
  194. passgen = ftype[:4] == 'pass'
  195. if not mmtype and not passgen:
  196. mmtype = self.segwit_mmtype
  197. cmd_pfx = (ftype,'pass')[passgen]
  198. t = self.spawn(f'mmgen-{cmd_pfx}gen',
  199. ['-d',self.tmpdir] + extra_args +
  200. ([],['--type='+str(mmtype)])[bool(mmtype)] +
  201. ([],['--stdout'])[stdout] +
  202. ([],[wf])[bool(wf)] +
  203. ([],[id_str])[bool(id_str)] +
  204. [getattr(self,f'{cmd_pfx}_idx_list')],
  205. extra_desc=f'({mmtype})' if mmtype in ('segwit','bech32') else '')
  206. t.license()
  207. wcls = get_wallet_cls( ext = 'mmdat' if dfl_wallet else get_extension(wf) )
  208. t.passphrase(wcls.desc,self.wpasswd)
  209. t.expect('Passphrase is OK')
  210. desc = ('address','password')[passgen]
  211. chk = t.expect_getend(rf'Checksum for {desc} data .*?: ',regex=True)
  212. if passgen:
  213. t.expect('Encrypt password list? (y/N): ','N')
  214. t.read() if stdout else t.written_to_file(('Addresses','Password list')[passgen])
  215. if check_ref:
  216. chk_ref = (self.chk_data[self.test_name] if passgen else
  217. self.chk_data[self.test_name][self.fork][self.proto.testnet])
  218. cmp_or_die(chk,chk_ref,desc=f'{ftype}list data checksum')
  219. return t
  220. def keyaddrgen(self,wf,pf=None,check_ref=False,mmtype=None):
  221. if not mmtype:
  222. mmtype = self.segwit_mmtype
  223. args = ['-d',self.tmpdir,self.usr_rand_arg,wf,self.addr_idx_list]
  224. t = self.spawn('mmgen-keygen',
  225. ([],['--type='+str(mmtype)])[bool(mmtype)] + args,
  226. extra_desc=f'({mmtype})' if mmtype in ('segwit','bech32') else '')
  227. t.license()
  228. wcls = get_wallet_cls(ext=get_extension(wf))
  229. t.passphrase(wcls.desc,self.wpasswd)
  230. chk = t.expect_getend(r'Checksum for key-address data .*?: ',regex=True)
  231. if check_ref:
  232. chk_ref = self.chk_data[self.test_name][self.fork][self.proto.testnet]
  233. cmp_or_die(chk,chk_ref,desc='key-address list data checksum')
  234. t.expect('Encrypt key list? (y/N): ','y')
  235. t.usr_rand(self.usr_rand_chars)
  236. t.hash_preset('new key-address list','1')
  237. t.passphrase_new('new key-address list',self.kapasswd)
  238. t.written_to_file('Encrypted secret keys',oo=True)
  239. return t
  240. def _do_confirm_send(self,t,quiet=False,confirm_send=True,sure=True):
  241. if sure:
  242. t.expect('Are you sure you want to broadcast this')
  243. m = ('YES, I REALLY WANT TO DO THIS','YES')[quiet]
  244. t.expect(f'{m!r} to confirm: ',('',m)[confirm_send]+'\n')