193 lines
7.3 KiB
Python
193 lines
7.3 KiB
Python
# (c) Copyright 2020 by Coinkite Inc. This file is covered by license found in COPYING-CC.
|
|
#
|
|
import pytest, time, os
|
|
from ckcc_protocol.constants import *
|
|
from pycoin.key.BIP32Node import BIP32Node
|
|
from pycoin.contrib.segwit_addr import encode as sw_encode
|
|
from pycoin.encoding import a2b_hashed_base58, hash160
|
|
|
|
@pytest.fixture
|
|
def mk_common_derivations():
|
|
def doit(netcode):
|
|
netcode_map = {'BTC': '0', 'XTN': '1'}
|
|
if netcode not in netcode_map.keys():
|
|
raise ValueError(netcode)
|
|
coin_type = netcode_map[netcode]
|
|
return [
|
|
# path format, address format
|
|
( "m/{change}/{idx}", AF_CLASSIC ),
|
|
#( "m/{account}'/{change}'/{idx}'", AF_CLASSIC ),
|
|
#( "m/{account}'/{change}'/{idx}'", AF_P2WPKH ),
|
|
( "m/44'/{coin_type}'/{account}'/{change}/{idx}".replace('{coin_type}', coin_type), AF_CLASSIC ),
|
|
( "m/49'/{coin_type}'/{account}'/{change}/{idx}".replace('{coin_type}', coin_type), AF_P2WPKH_P2SH ),
|
|
( "m/84'/{coin_type}'/{account}'/{change}/{idx}".replace('{coin_type}', coin_type), AF_P2WPKH )
|
|
]
|
|
return doit
|
|
|
|
@pytest.fixture
|
|
def goto_address_explorer(goto_home, pick_menu_item, need_keypress):
|
|
def doit(click_idx=None):
|
|
goto_home()
|
|
pick_menu_item('Address Explorer')
|
|
|
|
if click_idx is not None:
|
|
need_keypress('4') # click into stub menu
|
|
time.sleep(0.01)
|
|
|
|
for _ in range(2): # top of menu (requires two left clicks)
|
|
need_keypress('7')
|
|
time.sleep(0.01)
|
|
|
|
for _ in range(click_idx): # iterate down
|
|
need_keypress('8')
|
|
time.sleep(0.01)
|
|
|
|
need_keypress('y')
|
|
time.sleep(0.01)
|
|
return doit
|
|
|
|
@pytest.fixture
|
|
def parse_display_screen(cap_story):
|
|
# start: index of first address displayed in body
|
|
# n: number of addresses displayed in body
|
|
# return: dictionary of subpath => address
|
|
def doit(start, n):
|
|
title, body = cap_story()
|
|
lines = body.split('\n')
|
|
if start == 0:
|
|
assert 'Press 1 to save to MicroSD.' in lines[0]
|
|
assert '4 to view QR Codes' in lines[0]
|
|
assert lines[2] == 'Addresses %d..%d:' % (start, start + n - 1)
|
|
raw_addrs = lines[4:-2] # Remove header & last line
|
|
else:
|
|
# no header after first page
|
|
assert lines[0] == 'Addresses %d..%d:' % (start, start + n - 1)
|
|
raw_addrs = lines[2:-2]
|
|
|
|
d = dict()
|
|
for path_raw, addr, empty in zip(*[iter(raw_addrs)]*3):
|
|
path = path_raw.split(" =>")[0]
|
|
d[path] = addr
|
|
return d
|
|
return doit
|
|
|
|
@pytest.fixture
|
|
def validate_address():
|
|
# Check whether an address is covered by the given subkey
|
|
def doit(addr, sk):
|
|
if addr[0] in '1mn':
|
|
assert addr == sk.address(False)
|
|
elif addr[0:3] in { 'bc1', 'tb1' }:
|
|
h20 = sk.hash160()
|
|
assert addr == sw_encode(addr[0:2], 0, h20)
|
|
elif addr[0] in '23':
|
|
h20 = hash160(b'\x00\x14' + sk.hash160())
|
|
assert h20 == a2b_hashed_base58(addr)[1:]
|
|
else:
|
|
raise ValueError(addr)
|
|
return doit
|
|
|
|
@pytest.fixture
|
|
def generate_addresses_file(goto_address_explorer, need_keypress, cap_story, open_microsd):
|
|
# Generates the address file through the simulator, reads the file and
|
|
# returns a list of tuples of the form (subpath, address)
|
|
def doit(click_idx, expected_qty=250):
|
|
goto_address_explorer(click_idx=click_idx)
|
|
need_keypress('1')
|
|
time.sleep(.5) # always long enough to write the file?
|
|
title, body = cap_story()
|
|
header, fn = body.split("\n\n")
|
|
assert header == "Address summary file written:"
|
|
|
|
addr_dump = open_microsd(fn.strip(), 'rt')
|
|
|
|
import csv
|
|
cc = csv.reader(addr_dump)
|
|
hdr = next(cc)
|
|
assert hdr == ['Index', 'Payment Address', 'Derivation']
|
|
for n, (idx, addr, deriv) in enumerate(cc):
|
|
assert int(idx) == n
|
|
assert ('/%s' % idx) in deriv
|
|
|
|
yield deriv, addr
|
|
|
|
assert (n+1) == expected_qty
|
|
|
|
return doit
|
|
|
|
def test_stub_menu(sim_execfile, goto_address_explorer, need_keypress, cap_menu, mk_common_derivations, parse_display_screen, validate_address):
|
|
# For a given wallet, ensure the explorer shows the correct stub addresses
|
|
node_prv = BIP32Node.from_wallet_key(
|
|
sim_execfile('devtest/dump_private.py').strip()
|
|
)
|
|
common_derivs = mk_common_derivations(node_prv.netcode())
|
|
|
|
# capture menu address stubs
|
|
goto_address_explorer()
|
|
need_keypress('4')
|
|
time.sleep(.01)
|
|
m = cap_menu()
|
|
|
|
for idx, (path, addr_format) in enumerate(common_derivs):
|
|
# derive index=0 address
|
|
subpath = path.format(account=0, change=0, idx=0) # e.g. "m/44'/1'/0'/0/0"
|
|
sk = node_prv.subkey_for_path(subpath[2:])
|
|
|
|
# capture full index=0 address from display screen & validate it
|
|
goto_address_explorer(click_idx=idx)
|
|
addr_dict = parse_display_screen(0, 10)
|
|
if subpath not in addr_dict:
|
|
raise Exception('Subpath ("%s") not found in address explorer display' % subpath)
|
|
expected_addr = addr_dict[subpath]
|
|
validate_address(expected_addr, sk)
|
|
|
|
# validate that stub is correct
|
|
[start, end] = m[idx].split('-')
|
|
assert start in expected_addr
|
|
assert end in expected_addr
|
|
|
|
@pytest.mark.parametrize('press_seq, expected_start, expected_n', [
|
|
(['9', '9', '9', '7', '7', '9'], 20, 10), # forward backward forward
|
|
([], 0, 10), # initial
|
|
(['7', '7', '9'], 10, 10), # backwards at start is idempotent
|
|
(['9', '9', '9', '9', '9', '9', '9', '9', '9', '9'], 100, 10)
|
|
])
|
|
def test_address_display(goto_address_explorer, parse_display_screen, mk_common_derivations, need_keypress, sim_execfile, validate_address, press_seq, expected_start, expected_n):
|
|
# The proper addresses are displayed
|
|
# given the sequence of keys pressed
|
|
node_prv = BIP32Node.from_wallet_key(
|
|
sim_execfile('devtest/dump_private.py').strip()
|
|
)
|
|
common_derivs = mk_common_derivations(node_prv.netcode())
|
|
for click_idx, (path, addr_format) in enumerate(common_derivs):
|
|
# Click on specified derivation idx in explorer
|
|
goto_address_explorer(click_idx=click_idx)
|
|
|
|
# perform keypad press sequence
|
|
for key in press_seq:
|
|
need_keypress(key)
|
|
time.sleep(0.01)
|
|
|
|
# validate each address on screen
|
|
addr_dict = parse_display_screen(expected_start, expected_n)
|
|
for subpath, given_addr in addr_dict.items():
|
|
sk = node_prv.subkey_for_path(subpath[2:])
|
|
validate_address(given_addr, sk)
|
|
|
|
@pytest.mark.parametrize('click_idx', range(6))
|
|
def test_dump_addresses(generate_addresses_file, mk_common_derivations, sim_execfile, validate_address, click_idx):
|
|
# Validate addresses dumped to text file
|
|
node_prv = BIP32Node.from_wallet_key(
|
|
sim_execfile('devtest/dump_private.py').strip()
|
|
)
|
|
|
|
common_derivs = mk_common_derivations(node_prv.netcode())
|
|
|
|
# Generate the addresses file and get each line in a list
|
|
for subpath, addr in generate_addresses_file(click_idx):
|
|
# derive the subkey and validate the corresponding address
|
|
sk = node_prv.subkey_for_path(subpath[2:])
|
|
validate_address(addr, sk)
|
|
|
|
# EOF
|