From f9534e79e3fe19a7e48ccef2e2182585241005ce Mon Sep 17 00:00:00 2001 From: kdmukai Date: Mon, 20 Jan 2025 11:39:39 -0600 Subject: [PATCH 01/23] fixes uppercase bug; adds tests --- src/seedsigner/models/decode_qr.py | 110 +++++++++++-------- tests/test_decodepsbtqr.py | 171 +++++++++++++++++++---------- 2 files changed, 173 insertions(+), 108 deletions(-) diff --git a/src/seedsigner/models/decode_qr.py b/src/seedsigner/models/decode_qr.py index e98a2c56..c37fee3f 100644 --- a/src/seedsigner/models/decode_qr.py +++ b/src/seedsigner/models/decode_qr.py @@ -507,8 +507,7 @@ class DecodeQR: def is_bitcoin_address(s): if re.search(r'^bitcoin\:.*', s, re.IGNORECASE): return True - elif re.search(r'^((bc1|tb1|bcr|[123]|[mn])[a-zA-HJ-NP-Z0-9]{25,62})$', s): - # TODO: Handle regtest bcrt? + elif re.search(r'^((bc1|tb1|bcr|[123]|[mn])[a-zA-HJ-NP-Z0-9]{25,62})$', s, re.IGNORECASE): return True else: return False @@ -940,61 +939,78 @@ class BitcoinAddressQrDecoder(BaseSingleFrameQrDecoder): def add(self, segment, qr_type=QRType.BITCOIN_ADDRESS): - r = re.search(r'((bc1q|tb1q|bcrt1q|bc1p|tb1p|bcrt1p|[123]|[mn])[a-zA-HJ-NP-Z0-9]{25,64})', segment) - if r != None: - self.address = r.group(1) - - if re.search(r'^((bc1q|tb1q|bcrt1q|bc1p|tb1p|bcrt1p|[123]|[mn])[a-zA-HJ-NP-Z0-9]{25,64})$', self.address) != None: - self.complete = True - self.collected_segments = 1 - - # get address type - r = re.search(r'^((bc1q|tb1q|bcrt1q|bc1p|tb1p|bcrt1p|[123]|[mn])[a-zA-HJ-NP-Z0-9]{25,64})$', self.address) - if r != None: - r = r.group(2) - - if r == "1": - # Legacy P2PKH. mainnet - self.address_type = (SettingsConstants.LEGACY_P2PKH, SettingsConstants.MAINNET) + """ + Input may be prefixed with "bitcoin:" but will be ignored. - elif r == "m" or r == "n": - self.address_type = (SettingsConstants.LEGACY_P2PKH, SettingsConstants.TESTNET) + RegEx searches for a recognizable bitcoin address. + * The `^` ensures that the specified address prefixes can only match at + the beginning of the address. - elif r == "3": - # Nested segwit single sig (p2sh-p2wpkh), nested segwit multisig (p2sh-p2wsh), or legacy multisig (p2sh); mainnet - # TODO: Would be more correct to use a P2SH constant - self.address_type = (SettingsConstants.NESTED_SEGWIT, SettingsConstants.MAINNET) + Result will yield the following match groups: + * group 1: complete address + * group 2: address prefix + """ + address_match = re.search(r'^((bc1q|tb1q|bcrt1q|bc1p|tb1p|bcrt1p|[123]|[mn])[a-zA-HJ-NP-Z0-9]{25,64})', segment.split(":")[-1], re.IGNORECASE) + if address_match != None: + self.address = address_match.group(1) + self.complete = True + self.collected_segments = 1 + + # Have to handle wallets that uppercase bech32 addresses. + # Note that it's safe to lowercase the prefix for ALL addr formats. + addr_prefix = address_match.group(2).lower() + + if addr_prefix == "1": + # Legacy P2PKH. mainnet + self.address_type = (SettingsConstants.LEGACY_P2PKH, SettingsConstants.MAINNET) - elif r == "2": - # Nested segwit single sig (p2sh-p2wpkh), nested segwit multisig (p2sh-p2wsh), or legacy multisig (p2sh); testnet / regtest - self.address_type = (SettingsConstants.NESTED_SEGWIT, SettingsConstants.TESTNET) + elif addr_prefix == "m" or addr_prefix == "n": + self.address_type = (SettingsConstants.LEGACY_P2PKH, SettingsConstants.TESTNET) - elif r == "bc1q": - # Native Segwit (single sig or multisig), mainnet - self.address_type = (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.MAINNET) + elif addr_prefix == "3": + # Nested segwit single sig (p2sh-p2wpkh), nested segwit multisig (p2sh-p2wsh), or legacy multisig (p2sh); mainnet + # TODO: Would be more correct to use a P2SH constant + self.address_type = (SettingsConstants.NESTED_SEGWIT, SettingsConstants.MAINNET) - elif r == "tb1q": - # Native Segwit (single sig or multisig), testnet - self.address_type = (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TESTNET) + elif addr_prefix == "2": + # Nested segwit single sig (p2sh-p2wpkh), nested segwit multisig (p2sh-p2wsh), or legacy multisig (p2sh); testnet / regtest + self.address_type = (SettingsConstants.NESTED_SEGWIT, SettingsConstants.TESTNET) - elif r == "bcrt1q": - # Native Segwit (single sig or multisig), regtest - self.address_type = (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.REGTEST) + elif addr_prefix == "bc1q": + # Native Segwit (single sig or multisig), mainnet + self.address_type = (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.MAINNET) - elif r == "bc1p": - # Native Segwit (single sig or multisig), mainnet - self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.MAINNET) + elif addr_prefix == "tb1q": + # Native Segwit (single sig or multisig), testnet + self.address_type = (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TESTNET) - elif r == "tb1p": - # Native Segwit (single sig or multisig), testnet - self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.TESTNET) + elif addr_prefix == "bcrt1q": + # Native Segwit (single sig or multisig), regtest + self.address_type = (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.REGTEST) - elif r == "bcrt1p": - # Native Segwit (single sig or multisig), regtest - self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.REGTEST) - - return DecodeQRStatus.COMPLETE + elif addr_prefix == "bc1p": + # Native Segwit (single sig or multisig), mainnet + self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.MAINNET) + elif addr_prefix == "tb1p": + # Native Segwit (single sig or multisig), testnet + self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.TESTNET) + + elif addr_prefix == "bcrt1p": + # Native Segwit (single sig or multisig), regtest + self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.REGTEST) + + else: + logger.debug(f"Unknown address prefix: {addr_prefix}") + return DecodeQRStatus.INVALID + + # If the addr type is case-insensitive, ensure we return it lowercase + if self.address_type[0] in [SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TAPROOT]: + self.address = self.address.lower() + + return DecodeQRStatus.COMPLETE + + logger.debug(f"Invalid address: {segment}") return DecodeQRStatus.INVALID diff --git a/tests/test_decodepsbtqr.py b/tests/test_decodepsbtqr.py index 9b7d6981..a3bbd2f5 100644 --- a/tests/test_decodepsbtqr.py +++ b/tests/test_decodepsbtqr.py @@ -281,69 +281,118 @@ def test_short_4_letter_mnemonic_qr(): assert d.get_seed_phrase() == ["height", "demise", "useless", "trap", "grow", "lion", "found", "off", "key", "clown", "transfer", "enroll"] -def test_bitcoin_address(): - bad1 = "loremipsum" - bad2 = "0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae" - bad3 = "121802020768124106400009195602431595117715840445" - - legacy_address1 = "1KFHE7w8BhaENAswwryaoccDb6qcT6DbYY" - legacy_address2 = "16ftSEQ4ctQFDtVZiUBusQUjRrGhM3JYwe" - - main_bech32_address = "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq" - test_bech32_address = "tb1qkurj377gtlmu0j5flcykcsh2xagexh9h3jk06a" - - main_nested_segwit_address = "3Nu78Cqcf6hsD4sUBAN9nP13tYiHU9QPFX" - test_nested_segwit_address = "2N6JbrvPMMwbBhu2KxqXyyHUQz3XKspvyfm" - - main_bech32_address2 = "bitcoin:bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq?amount=12000" - main_bech32_address3 = "BITCOIN:bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq?junk" - - d = DecodeQR() - d.add_data(bad1) - - assert d.qr_type == QRType.INVALID - - d = DecodeQR() - d.add_data(legacy_address1) - - assert d.get_address() == legacy_address1 - assert d.get_address_type() == (SettingsConstants.LEGACY_P2PKH, SettingsConstants.MAINNET) - - d = DecodeQR() - d.add_data(legacy_address2) - - assert d.get_address() == legacy_address2 - assert d.get_address_type() == (SettingsConstants.LEGACY_P2PKH, SettingsConstants.MAINNET) - - d = DecodeQR() - d.add_data(main_bech32_address) - - assert d.get_address() == main_bech32_address - assert d.get_address_type() == (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.MAINNET) - - d = DecodeQR() - d.add_data(test_bech32_address) - - assert d.get_address() == test_bech32_address - assert d.get_address_type() == (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TESTNET) - - d = DecodeQR() - d.add_data(main_nested_segwit_address) - - assert d.get_address() == main_nested_segwit_address - assert d.get_address_type() == (SettingsConstants.NESTED_SEGWIT, SettingsConstants.MAINNET) - - d = DecodeQR() - d.add_data(test_nested_segwit_address) +# Test data for bitcoin address decoding +legacy_address1 = "1KFHE7w8BhaENAswwryaoccDb6qcT6DbYY" +legacy_address2 = "16ftSEQ4ctQFDtVZiUBusQUjRrGhM3JYwe" - assert d.get_address() == test_nested_segwit_address - assert d.get_address_type() == (SettingsConstants.NESTED_SEGWIT, SettingsConstants.TESTNET) +main_nested_segwit_address = "3Nu78Cqcf6hsD4sUBAN9nP13tYiHU9QPFX" +test_nested_segwit_address = "2N6JbrvPMMwbBhu2KxqXyyHUQz3XKspvyfm" - d = DecodeQR() - d.add_data(main_bech32_address2) - - assert d.get_address() == "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq" - assert d.get_address_type() == (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.MAINNET) +main_native_segwit_address = "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq" +test_native_segwit_address = "tb1qkurj377gtlmu0j5flcykcsh2xagexh9h3jk06a" + +main_taproot_address = "bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr" +test_taproot_address = "tb1p8wpt9v4frpf3tkn0srd97pksgsxc5hs52lafxwru9kgeephvs7rqlqt9zj" +regtest_taproot_address = "bcrt1p8wpt9v4frpf3tkn0srd97pksgsxc5hs52lafxwru9kgeephvs7rqjeprhg" + + + +def test_bitcoin_address(): + """ + Decoder should parse various types of valid bitcoin addresses with or without the + "bitcoin:" prefix and optional query params. + """ + def decode(address, expected_script_type, expected_network=SettingsConstants.MAINNET): + for data in [address, "bitcoin:" + address, "bitcoin:" + address + "?amount=12000"]: + d = DecodeQR() + d.add_data(data) + assert d.get_address() == address + assert d.get_address_type() == (expected_script_type, expected_network) + + decode(legacy_address1, SettingsConstants.LEGACY_P2PKH) + decode(legacy_address2, SettingsConstants.LEGACY_P2PKH) + decode(main_nested_segwit_address, SettingsConstants.NESTED_SEGWIT) + decode(test_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, SettingsConstants.TESTNET) + decode(main_native_segwit_address, SettingsConstants.NATIVE_SEGWIT) + decode(test_native_segwit_address, SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TESTNET) + decode(main_taproot_address, SettingsConstants.TAPROOT) + decode(test_taproot_address, SettingsConstants.TAPROOT, SettingsConstants.TESTNET) + decode(regtest_taproot_address, SettingsConstants.TAPROOT, SettingsConstants.REGTEST) + + + +def test_invalid_bitcoin_address(): + """ + Decoder should fail to parse invalid address data. + * Test incorrect "bitcoin:" prefix. + * Test invalid addresses. + * Test valid addresses w/additional prefixes (to ensure regexp is not finding + mid-string matches) which make the data invalid. + """ + bad_inputs = [ + # wrong separator char + "bitcoin=bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq", + + # Unrecognized addr prefix + "bitcoin:bcfakehrp1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq", + + # valid addr w/garbage addr prefix + "abcbc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq", + + # valid "bitcoin:" prefix w/garbage addr prefix + "bitcoin:abcbc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq", + + # typo in "bitcoin:" prefix + "bitcon:bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq", + ] + + for bad_input in bad_inputs: + d = DecodeQR() + status = d.add_data(bad_input) + assert status == DecodeQRStatus.INVALID + + + +def test_bitcoin_address_ignores_case_where_allowed(): + """ + Decoder should ignore case in QR data prefix and in the address itself (for the + address types where case is ignored). + """ + def decode(address, expected_script_type, is_case_sensitive, expected_network=SettingsConstants.MAINNET): + addr_variations = [address] + if not is_case_sensitive: + # Test as-is and all uppercase + addr_variations.append(address.upper()) + + for addr_variation in addr_variations: + # First add prefix capitalizations + variations_1 = ["bitcoin:" + addr_variation, "BITCOIN:" + addr_variation] + + # Now add query params + variations_2 = [v + "?amount=12000" for v in variations_1] + variations_3 = [v + "?AMOUNT=12000" for v in variations_1] + for data in [addr_variation] + variations_1 + variations_2 + variations_3: + d = DecodeQR() + d.add_data(data) + assert d.get_address_type() == (expected_script_type, expected_network) + + if not is_case_sensitive: + assert d.get_address() == addr_variation.lower() + else: + assert d.get_address() == addr_variation + + # Case sensitive address types + decode(legacy_address1, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True) + decode(legacy_address2, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True) + decode(main_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True) + decode(test_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True, expected_network=SettingsConstants.TESTNET) + + # Case insensitive address types + decode(main_native_segwit_address, SettingsConstants.NATIVE_SEGWIT, is_case_sensitive=False) + decode(test_native_segwit_address, SettingsConstants.NATIVE_SEGWIT, is_case_sensitive=False, expected_network=SettingsConstants.TESTNET) + decode(main_taproot_address, SettingsConstants.TAPROOT, is_case_sensitive=False) + decode(test_taproot_address, SettingsConstants.TAPROOT, is_case_sensitive=False, expected_network=SettingsConstants.TESTNET) + decode(regtest_taproot_address, SettingsConstants.TAPROOT, is_case_sensitive=False, expected_network=SettingsConstants.REGTEST) From 2bd32333e4f463f1e03af1810fbed51003164ca4 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Mon, 20 Jan 2025 11:52:40 -0600 Subject: [PATCH 02/23] minor improvement after reviewing coverage --- src/seedsigner/models/decode_qr.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/seedsigner/models/decode_qr.py b/src/seedsigner/models/decode_qr.py index c37fee3f..34a8ea93 100644 --- a/src/seedsigner/models/decode_qr.py +++ b/src/seedsigner/models/decode_qr.py @@ -964,7 +964,7 @@ class BitcoinAddressQrDecoder(BaseSingleFrameQrDecoder): # Legacy P2PKH. mainnet self.address_type = (SettingsConstants.LEGACY_P2PKH, SettingsConstants.MAINNET) - elif addr_prefix == "m" or addr_prefix == "n": + elif addr_prefix in ["m", "n"]: self.address_type = (SettingsConstants.LEGACY_P2PKH, SettingsConstants.TESTNET) elif addr_prefix == "3": @@ -999,10 +999,7 @@ class BitcoinAddressQrDecoder(BaseSingleFrameQrDecoder): elif addr_prefix == "bcrt1p": # Native Segwit (single sig or multisig), regtest self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.REGTEST) - - else: - logger.debug(f"Unknown address prefix: {addr_prefix}") - return DecodeQRStatus.INVALID + # Note: there is no final "else" here because the regex won't return any other matches. # If the addr type is case-insensitive, ensure we return it lowercase if self.address_type[0] in [SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TAPROOT]: From 684d1d077d9170d9377c5c995d69cc276b10bee1 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Mon, 20 Jan 2025 16:59:25 -0600 Subject: [PATCH 03/23] Add testnet legacy addr to tests --- tests/test_decodepsbtqr.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/test_decodepsbtqr.py b/tests/test_decodepsbtqr.py index a3bbd2f5..6e5230bb 100644 --- a/tests/test_decodepsbtqr.py +++ b/tests/test_decodepsbtqr.py @@ -284,6 +284,7 @@ def test_short_4_letter_mnemonic_qr(): # Test data for bitcoin address decoding legacy_address1 = "1KFHE7w8BhaENAswwryaoccDb6qcT6DbYY" legacy_address2 = "16ftSEQ4ctQFDtVZiUBusQUjRrGhM3JYwe" +test_legacy_address = "mkpZhYtJu2r87Js3pDiWJDmPte2NRZ8bJV" main_nested_segwit_address = "3Nu78Cqcf6hsD4sUBAN9nP13tYiHU9QPFX" test_nested_segwit_address = "2N6JbrvPMMwbBhu2KxqXyyHUQz3XKspvyfm" @@ -309,8 +310,9 @@ def test_bitcoin_address(): assert d.get_address() == address assert d.get_address_type() == (expected_script_type, expected_network) - decode(legacy_address1, SettingsConstants.LEGACY_P2PKH) + decode(legacy_address1, SettingsConstants.LEGACY_P2PKH) decode(legacy_address2, SettingsConstants.LEGACY_P2PKH) + decode(test_legacy_address, SettingsConstants.LEGACY_P2PKH, SettingsConstants.TESTNET) decode(main_nested_segwit_address, SettingsConstants.NESTED_SEGWIT) decode(test_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, SettingsConstants.TESTNET) decode(main_native_segwit_address, SettingsConstants.NATIVE_SEGWIT) @@ -384,6 +386,7 @@ def test_bitcoin_address_ignores_case_where_allowed(): # Case sensitive address types decode(legacy_address1, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True) decode(legacy_address2, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True) + decode(test_legacy_address, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True, expected_network=SettingsConstants.TESTNET) decode(main_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True) decode(test_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True, expected_network=SettingsConstants.TESTNET) From a90e7a6cc8861b74612d521d008031b22ba7cad9 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Mon, 20 Jan 2025 17:12:07 -0600 Subject: [PATCH 04/23] Use same test key for all test addrs; add native segwit regtest --- tests/test_decodepsbtqr.py | 62 +++++++++++++++++++------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/tests/test_decodepsbtqr.py b/tests/test_decodepsbtqr.py index 6e5230bb..7672d62b 100644 --- a/tests/test_decodepsbtqr.py +++ b/tests/test_decodepsbtqr.py @@ -281,20 +281,20 @@ def test_short_4_letter_mnemonic_qr(): assert d.get_seed_phrase() == ["height", "demise", "useless", "trap", "grow", "lion", "found", "off", "key", "clown", "transfer", "enroll"] -# Test data for bitcoin address decoding -legacy_address1 = "1KFHE7w8BhaENAswwryaoccDb6qcT6DbYY" -legacy_address2 = "16ftSEQ4ctQFDtVZiUBusQUjRrGhM3JYwe" -test_legacy_address = "mkpZhYtJu2r87Js3pDiWJDmPte2NRZ8bJV" +# Test data for bitcoin address decoding. All generated from test key: ["abandon"] * 11 + ["about"] +legacy_address_mainnet = "1LqBGSKuX5yYUonjxT5qGfpUsXKYYWeabA" +legacy_address_testnet = "mkpZhYtJu2r87Js3pDiWJDmPte2NRZ8bJV" -main_nested_segwit_address = "3Nu78Cqcf6hsD4sUBAN9nP13tYiHU9QPFX" -test_nested_segwit_address = "2N6JbrvPMMwbBhu2KxqXyyHUQz3XKspvyfm" +nested_segwit_address_mainnet = "37VucYSaXLCAsxYyAPfbSi9eh4iEcbShgf" +nested_segwit_address_testnet = "2Mww8dCYPUpKHofjgcXcBCEGmniw9CoaiD2" -main_native_segwit_address = "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq" -test_native_segwit_address = "tb1qkurj377gtlmu0j5flcykcsh2xagexh9h3jk06a" +native_segwit_address_mainnet = "bc1qcr8te4kr609gcawutmrza0j4xv80jy8z306fyu" +native_segwit_address_testnet = "tb1q6rz28mcfaxtmd6v789l9rrlrusdprr9pqcpvkl" +native_segwit_address_regtest = "bcrt1q6rz28mcfaxtmd6v789l9rrlrusdprr9pz3cppk" -main_taproot_address = "bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr" -test_taproot_address = "tb1p8wpt9v4frpf3tkn0srd97pksgsxc5hs52lafxwru9kgeephvs7rqlqt9zj" -regtest_taproot_address = "bcrt1p8wpt9v4frpf3tkn0srd97pksgsxc5hs52lafxwru9kgeephvs7rqjeprhg" +taproot_address_mainnet = "bc1p5cyxnuxmeuwuvkwfem96lqzszd02n6xdcjrs20cac6yqjjwudpxqkedrcr" +taproot_address_testnet = "tb1p8wpt9v4frpf3tkn0srd97pksgsxc5hs52lafxwru9kgeephvs7rqlqt9zj" +taproot_address_regtest = "bcrt1p8wpt9v4frpf3tkn0srd97pksgsxc5hs52lafxwru9kgeephvs7rqjeprhg" @@ -310,16 +310,16 @@ def test_bitcoin_address(): assert d.get_address() == address assert d.get_address_type() == (expected_script_type, expected_network) - decode(legacy_address1, SettingsConstants.LEGACY_P2PKH) - decode(legacy_address2, SettingsConstants.LEGACY_P2PKH) - decode(test_legacy_address, SettingsConstants.LEGACY_P2PKH, SettingsConstants.TESTNET) - decode(main_nested_segwit_address, SettingsConstants.NESTED_SEGWIT) - decode(test_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, SettingsConstants.TESTNET) - decode(main_native_segwit_address, SettingsConstants.NATIVE_SEGWIT) - decode(test_native_segwit_address, SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TESTNET) - decode(main_taproot_address, SettingsConstants.TAPROOT) - decode(test_taproot_address, SettingsConstants.TAPROOT, SettingsConstants.TESTNET) - decode(regtest_taproot_address, SettingsConstants.TAPROOT, SettingsConstants.REGTEST) + decode(legacy_address_mainnet, SettingsConstants.LEGACY_P2PKH) + decode(legacy_address_testnet, SettingsConstants.LEGACY_P2PKH, SettingsConstants.TESTNET) + decode(nested_segwit_address_mainnet, SettingsConstants.NESTED_SEGWIT) + decode(nested_segwit_address_testnet, SettingsConstants.NESTED_SEGWIT, SettingsConstants.TESTNET) + decode(native_segwit_address_mainnet, SettingsConstants.NATIVE_SEGWIT) + decode(native_segwit_address_testnet, SettingsConstants.NATIVE_SEGWIT, SettingsConstants.TESTNET) + decode(native_segwit_address_regtest, SettingsConstants.NATIVE_SEGWIT, SettingsConstants.REGTEST) + decode(taproot_address_mainnet, SettingsConstants.TAPROOT) + decode(taproot_address_testnet, SettingsConstants.TAPROOT, SettingsConstants.TESTNET) + decode(taproot_address_regtest, SettingsConstants.TAPROOT, SettingsConstants.REGTEST) @@ -384,18 +384,18 @@ def test_bitcoin_address_ignores_case_where_allowed(): assert d.get_address() == addr_variation # Case sensitive address types - decode(legacy_address1, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True) - decode(legacy_address2, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True) - decode(test_legacy_address, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True, expected_network=SettingsConstants.TESTNET) - decode(main_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True) - decode(test_nested_segwit_address, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True, expected_network=SettingsConstants.TESTNET) + decode(legacy_address_mainnet, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True) + decode(legacy_address_testnet, SettingsConstants.LEGACY_P2PKH, is_case_sensitive=True, expected_network=SettingsConstants.TESTNET) + decode(nested_segwit_address_mainnet, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True) + decode(nested_segwit_address_testnet, SettingsConstants.NESTED_SEGWIT, is_case_sensitive=True, expected_network=SettingsConstants.TESTNET) # Case insensitive address types - decode(main_native_segwit_address, SettingsConstants.NATIVE_SEGWIT, is_case_sensitive=False) - decode(test_native_segwit_address, SettingsConstants.NATIVE_SEGWIT, is_case_sensitive=False, expected_network=SettingsConstants.TESTNET) - decode(main_taproot_address, SettingsConstants.TAPROOT, is_case_sensitive=False) - decode(test_taproot_address, SettingsConstants.TAPROOT, is_case_sensitive=False, expected_network=SettingsConstants.TESTNET) - decode(regtest_taproot_address, SettingsConstants.TAPROOT, is_case_sensitive=False, expected_network=SettingsConstants.REGTEST) + decode(native_segwit_address_mainnet, SettingsConstants.NATIVE_SEGWIT, is_case_sensitive=False) + decode(native_segwit_address_testnet, SettingsConstants.NATIVE_SEGWIT, is_case_sensitive=False, expected_network=SettingsConstants.TESTNET) + decode(native_segwit_address_regtest, SettingsConstants.NATIVE_SEGWIT, is_case_sensitive=False, expected_network=SettingsConstants.REGTEST) + decode(taproot_address_mainnet, SettingsConstants.TAPROOT, is_case_sensitive=False) + decode(taproot_address_testnet, SettingsConstants.TAPROOT, is_case_sensitive=False, expected_network=SettingsConstants.TESTNET) + decode(taproot_address_regtest, SettingsConstants.TAPROOT, is_case_sensitive=False, expected_network=SettingsConstants.REGTEST) From b541112ab4ebb72fd0a389032bb3ff66616e8d87 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Tue, 21 Jan 2025 08:45:52 -0600 Subject: [PATCH 05/23] Enable basic p2tr addr verification; add test --- src/seedsigner/views/seed_views.py | 8 ++------ tests/test_flows_tools.py | 31 +++++++++++++++++++----------- 2 files changed, 22 insertions(+), 17 deletions(-) diff --git a/src/seedsigner/views/seed_views.py b/src/seedsigner/views/seed_views.py index 79313f04..7a9c5121 100644 --- a/src/seedsigner/views/seed_views.py +++ b/src/seedsigner/views/seed_views.py @@ -1722,8 +1722,8 @@ class AddressVerificationStartView(View): destination = Destination(SeedSelectSeedView, view_args=dict(flow=Controller.FLOW__VERIFY_SINGLESIG_ADDR), skip_current_view=True) elif self.controller.unverified_address["script_type"] == SettingsConstants.TAPROOT: - # TODO: add Taproot support - return Destination(NotYetImplementedView) + sig_type = SettingsConstants.SINGLE_SIG + destination = Destination(SeedSelectSeedView, view_args=dict(flow=Controller.FLOW__VERIFY_SINGLESIG_ADDR), skip_current_view=True) derivation_path = embit_utils.get_standard_derivation_path( network=self.controller.unverified_address["network"], @@ -1816,10 +1816,6 @@ class SeedAddressVerificationView(View): self.sig_type = self.controller.unverified_address["sig_type"] self.network = self.controller.unverified_address["network"] - if self.script_type == SettingsConstants.TAPROOT: - # TODO: Taproot addr verification - return Destination(NotYetImplementedView) - # TODO: This should be in `Seed` or `PSBT` utility class embit_network = SettingsConstants.map_network_to_embit(self.network) diff --git a/tests/test_flows_tools.py b/tests/test_flows_tools.py index 968b72fc..a7bfa2c4 100644 --- a/tests/test_flows_tools.py +++ b/tests/test_flows_tools.py @@ -257,16 +257,25 @@ class TestToolsFlows(FlowTest): settings = controller.settings settings.set_value(SettingsConstants.SETTING__NETWORK, SettingsConstants.REGTEST) - def load_address_into_decoder(view: scan_views.ScanView): + addrs = [ # Native segwit regtest receive addr @ index 6 - view.decoder.add_data("bcrt1q4e9q5taxnsvc6m0uxv6h75mkzvnkxeqk6l90u2") + "bcrt1q4e9q5taxnsvc6m0uxv6h75mkzvnkxeqk6l90u2", - self.run_sequence([ - FlowStep(MainMenuView, button_data_selection=MainMenuView.TOOLS), - FlowStep(tools_views.ToolsMenuView, button_data_selection=tools_views.ToolsMenuView.VERIFY_ADDRESS), - FlowStep(scan_views.ScanAddressView, before_run=load_address_into_decoder), # simulate read address QR - FlowStep(seed_views.AddressVerificationStartView, is_redirect=True), - FlowStep(seed_views.SeedSelectSeedView, screen_return_value=0), - FlowStep(seed_views.SeedAddressVerificationView), - FlowStep(seed_views.SeedAddressVerificationSuccessView), - ]) + # Taproot regtest change addr @ index 48 + "bcrt1pj5v8ean2hc5lh2djsgfx4j9uc0n67942ngv6q9r49qv88ex5mrwsn3u4f7", + ] + + for test_addr in addrs: + def load_address_into_decoder(view: scan_views.ScanView): + # Native segwit regtest receive addr @ index 6 + view.decoder.add_data(test_addr) + + self.run_sequence([ + FlowStep(MainMenuView, button_data_selection=MainMenuView.TOOLS), + FlowStep(tools_views.ToolsMenuView, button_data_selection=tools_views.ToolsMenuView.VERIFY_ADDRESS), + FlowStep(scan_views.ScanAddressView, before_run=load_address_into_decoder), # simulate read address QR + FlowStep(seed_views.AddressVerificationStartView, is_redirect=True), + FlowStep(seed_views.SeedSelectSeedView, screen_return_value=0), + FlowStep(seed_views.SeedAddressVerificationView), + FlowStep(seed_views.SeedAddressVerificationSuccessView), + ]) From defaed08992d83cc5d460234a9dbf8909294e9b0 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Tue, 21 Jan 2025 12:27:40 -0600 Subject: [PATCH 06/23] Remove incorrect and unnecessary comments --- src/seedsigner/models/decode_qr.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/seedsigner/models/decode_qr.py b/src/seedsigner/models/decode_qr.py index 34a8ea93..1135a140 100644 --- a/src/seedsigner/models/decode_qr.py +++ b/src/seedsigner/models/decode_qr.py @@ -989,15 +989,12 @@ class BitcoinAddressQrDecoder(BaseSingleFrameQrDecoder): self.address_type = (SettingsConstants.NATIVE_SEGWIT, SettingsConstants.REGTEST) elif addr_prefix == "bc1p": - # Native Segwit (single sig or multisig), mainnet self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.MAINNET) elif addr_prefix == "tb1p": - # Native Segwit (single sig or multisig), testnet self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.TESTNET) elif addr_prefix == "bcrt1p": - # Native Segwit (single sig or multisig), regtest self.address_type = (SettingsConstants.TAPROOT, SettingsConstants.REGTEST) # Note: there is no final "else" here because the regex won't return any other matches. From 9942acd96a3a379d482e6fbc0e8975411ca47829 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Sat, 18 Jan 2025 23:07:44 -0600 Subject: [PATCH 07/23] swap icons in for SPACE and DEL --- src/seedsigner/gui/keyboard.py | 53 ++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/src/seedsigner/gui/keyboard.py b/src/seedsigner/gui/keyboard.py index b92b062b..0ccc91e9 100644 --- a/src/seedsigner/gui/keyboard.py +++ b/src/seedsigner/gui/keyboard.py @@ -3,7 +3,7 @@ from PIL import Image, ImageDraw, ImageFont from typing import Tuple from gettext import gettext as _ -from seedsigner.gui.components import Fonts, GUIConstants +from seedsigner.gui.components import Fonts, GUIConstants, SeedSignerIconConstants from seedsigner.hardware.buttons import HardwareButtonsConstants @@ -30,46 +30,43 @@ class Keyboard: ENTER_RIGHT = "enter_right" REGULAR_KEY_FONT = "regular" - COMPACT_KEY_FONT = "compact" + ICON_KEY_FONT = GUIConstants.ICON_FONT_NAME__SEEDSIGNER - # TRANSLATOR_NOTE: The abbreviated label for the special key on a standard keyboard. - del_label = _("del") KEY_BACKSPACE = { "code": "DEL", - "letter": del_label, - "font": COMPACT_KEY_FONT, + "letter": SeedSignerIconConstants.DELETE, + "font": ICON_KEY_FONT, "size": 2, } - # TRANSLATOR_NOTE: The abbreviated label for the special key on a standard keyboard. - space_label = _("space") + KEY_SPACE = { "code": "SPACE", - "letter": space_label, - "font": COMPACT_KEY_FONT, + "letter": SeedSignerIconConstants.SPACE, + "font": ICON_KEY_FONT, "size": 1, } KEY_SPACE_2 = { "code": "SPACE", - "letter": space_label, - "font": COMPACT_KEY_FONT, + "letter": SeedSignerIconConstants.SPACE, + "font": ICON_KEY_FONT, "size": 2, } KEY_SPACE_3 = { "code": "SPACE", - "letter": space_label, - "font": COMPACT_KEY_FONT, + "letter": SeedSignerIconConstants.SPACE, + "font": ICON_KEY_FONT, "size": 3, } KEY_SPACE_4 = { "code": "SPACE", - "letter": space_label, - "font": COMPACT_KEY_FONT, + "letter": SeedSignerIconConstants.SPACE, + "font": ICON_KEY_FONT, "size": 4, } KEY_SPACE_5 = { "code": "SPACE", - "letter": space_label, - "font": COMPACT_KEY_FONT, + "letter": SeedSignerIconConstants.SPACE, + "font": ICON_KEY_FONT, "size": 5, } KEY_CURSOR_LEFT = { @@ -123,9 +120,11 @@ class Keyboard: def render_key(self): font = self.keyboard.font + text_height = self.keyboard.text_height if self.is_additional_key: - if Keyboard.ADDITIONAL_KEYS[self.code]["font"] == Keyboard.COMPACT_KEY_FONT: - font = self.keyboard.additonal_key_compact_font + if Keyboard.ADDITIONAL_KEYS[self.code]["font"] == Keyboard.ICON_KEY_FONT: + font = self.keyboard.icon_key_font + text_height = self.keyboard.icon_key_height outline_color = "#333" if not self.is_active: @@ -159,15 +158,12 @@ class Keyboard: radius=4 ) - # Fixed-width fonts will all have same height, ignoring below baseline (e.g. "Q" or "q") - (left, top, right, bottom) = font.getbbox("X", anchor="ls") - text_height = -1 * top self.keyboard.draw.text( ( self.screen_x + int(self.keyboard.key_width * self.size / 2), self.screen_y + self.keyboard.key_height - int((self.keyboard.key_height - text_height)/2) ), - _(self.letter), + self.letter, fill=font_color, font=font, anchor="ms" @@ -217,8 +213,15 @@ class Keyboard: # Set up the rendering and state params self.active_keys = list(self.charset) + self.icon_key_font = Fonts.get_font(GUIConstants.ICON_FONT_NAME__SEEDSIGNER, 26) + + # Fixed-width fonts will all have same height, ignoring below baseline (e.g. "Q" or "q") + (left, top, right, bottom) = self.font.getbbox("X", anchor="ls") + self.text_height = -1 * top + + (left, top, right, bottom) = self.icon_key_font.getbbox(SeedSignerIconConstants.DELETE + SeedSignerIconConstants.SPACE, anchor="ls") + self.icon_key_height = -1 * top - self.additonal_key_compact_font = Fonts.get_font("RobotoCondensed-Bold", 18) self.x_start = rect[0] self.y_start = rect[1] self.x_gap = 2 From 9697d5ec3a0e7cbb7c853ba9c8ca0a619ea80cf1 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Sun, 19 Jan 2025 10:02:40 -0600 Subject: [PATCH 08/23] UI tweaks, minor fixes --- src/seedsigner/gui/components.py | 20 +++++-------------- src/seedsigner/gui/keyboard.py | 8 ++++---- src/seedsigner/gui/screens/screen.py | 2 +- .../gui/screens/settings_screens.py | 13 ++++++------ src/seedsigner/gui/screens/tools_screens.py | 2 +- src/seedsigner/views/psbt_views.py | 7 +++---- src/seedsigner/views/scan_views.py | 6 ++++++ src/seedsigner/views/seed_views.py | 5 ++++- src/seedsigner/views/view.py | 14 ++++++++++--- tests/screenshot_generator/generator.py | 18 +++++++++++------ 10 files changed, 53 insertions(+), 42 deletions(-) diff --git a/src/seedsigner/gui/components.py b/src/seedsigner/gui/components.py index 6414b71a..6c0f68ae 100644 --- a/src/seedsigner/gui/components.py +++ b/src/seedsigner/gui/components.py @@ -217,9 +217,9 @@ class SeedSignerIconConstants: # Messaging icons INFO = "\ue912" - ERROR = "\ue913" - SUCCESS = "\ue914" - WARNING = "\ue915" + SUCCESS = "\ue913" + WARNING = "\ue914" + ERROR = "\ue915" # Informational icons ADDRESS = "\ue916" @@ -241,8 +241,9 @@ class SeedSignerIconConstants: DELETE = "\ue922" SPACE = "\ue923" + # Must be updated whenever new icons are added. See usage in `Icon` class below. MIN_VALUE = SCAN - MAX_VALUE = QRCODE + MAX_VALUE = SPACE @@ -280,17 +281,6 @@ def calc_text_centering(font: ImageFont, -def load_icon(icon_name: str, load_selected_variant: bool = False): - icon_url = os.path.join(pathlib.Path(__file__).parent.resolve(), "..", "resources", "icons", icon_name) - icon = Image.open(icon_url + ".png").convert("RGB") - if not load_selected_variant: - return icon - else: - icon_selected = Image.open(icon_url + "_selected.png").convert("RGB") - return (icon, icon_selected) - - - def load_image(image_name: str) -> Image.Image: image_url = os.path.join(pathlib.Path(__file__).parent.resolve(), "..", "resources", "img", image_name) image = Image.open(image_url).convert("RGB") diff --git a/src/seedsigner/gui/keyboard.py b/src/seedsigner/gui/keyboard.py index 0ccc91e9..bc679ec5 100644 --- a/src/seedsigner/gui/keyboard.py +++ b/src/seedsigner/gui/keyboard.py @@ -71,14 +71,14 @@ class Keyboard: } KEY_CURSOR_LEFT = { "code": "CURSOR_LEFT", - "letter": "<", - "font": REGULAR_KEY_FONT, + "letter": SeedSignerIconConstants.CHEVRON_LEFT, + "font": ICON_KEY_FONT, "size": 1, } KEY_CURSOR_RIGHT = { "code": "CURSOR_RIGHT", - "letter": ">", - "font": REGULAR_KEY_FONT, + "letter": SeedSignerIconConstants.CHEVRON_RIGHT, + "font": ICON_KEY_FONT, "size": 1, } KEY_PREVIOUS_PAGE = { diff --git a/src/seedsigner/gui/screens/screen.py b/src/seedsigner/gui/screens/screen.py index 637b00a9..aa50f88e 100644 --- a/src/seedsigner/gui/screens/screen.py +++ b/src/seedsigner/gui/screens/screen.py @@ -309,7 +309,7 @@ class ButtonListScreen(BaseTopNavScreen): if len(self.button_data) == 1: button_list_height = button_height else: - button_list_height = (len(self.button_data) * button_height) + (GUIConstants.COMPONENT_PADDING * (len(self.button_data) - 1)) + button_list_height = (len(self.button_data) * button_height) + (GUIConstants.LIST_ITEM_PADDING * (len(self.button_data) - 1)) if self.is_bottom_list: button_list_y = self.canvas_height - (button_list_height + GUIConstants.EDGE_PADDING) diff --git a/src/seedsigner/gui/screens/settings_screens.py b/src/seedsigner/gui/screens/settings_screens.py index 794e5b2e..c41eadfc 100644 --- a/src/seedsigner/gui/screens/settings_screens.py +++ b/src/seedsigner/gui/screens/settings_screens.py @@ -6,7 +6,7 @@ from PIL.ImageOps import autocontrast from typing import List from seedsigner.helpers.l10n import mark_for_translation as _mft -from seedsigner.gui.components import Button, CheckboxButton, CheckedSelectionButton, FontAwesomeIconConstants, Fonts, GUIConstants, Icon, IconButton, IconTextLine, TextArea +from seedsigner.gui.components import Button, CheckboxButton, CheckedSelectionButton, FontAwesomeIconConstants, Fonts, GUIConstants, Icon, IconButton, IconTextLine, SeedSignerIconConstants, TextArea from seedsigner.gui.screens.scan_screens import ScanScreen from seedsigner.gui.screens.screen import BaseScreen, BaseTopNavScreen, ButtonListScreen, ButtonOption from seedsigner.hardware.buttons import HardwareButtonsConstants @@ -82,7 +82,7 @@ class IOTestScreen(BaseTopNavScreen): self.components.append(self.joystick_click_button) self.joystick_up_button = IconButton( - icon_name=FontAwesomeIconConstants.ANGLE_UP, + icon_name=SeedSignerIconConstants.CHEVRON_UP, icon_size=GUIConstants.ICON_INLINE_FONT_SIZE, width=input_button_width, height=input_button_height, @@ -93,7 +93,7 @@ class IOTestScreen(BaseTopNavScreen): self.components.append(self.joystick_up_button) self.joystick_down_button = IconButton( - icon_name=FontAwesomeIconConstants.ANGLE_DOWN, + icon_name=SeedSignerIconConstants.CHEVRON_DOWN, icon_size=GUIConstants.ICON_INLINE_FONT_SIZE, width=input_button_width, height=input_button_height, @@ -104,9 +104,8 @@ class IOTestScreen(BaseTopNavScreen): self.components.append(self.joystick_down_button) self.joystick_left_button = IconButton( - text=FontAwesomeIconConstants.ANGLE_LEFT, - font_name=GUIConstants.ICON_FONT_NAME__FONT_AWESOME, - font_size=GUIConstants.ICON_INLINE_FONT_SIZE, + icon_name=SeedSignerIconConstants.CHEVRON_LEFT, + icon_size=GUIConstants.ICON_INLINE_FONT_SIZE, width=input_button_width, height=input_button_height, screen_x=dpad_center_x - input_button_width - GUIConstants.COMPONENT_PADDING, @@ -116,7 +115,7 @@ class IOTestScreen(BaseTopNavScreen): self.components.append(self.joystick_left_button) self.joystick_right_button = IconButton( - icon_name=FontAwesomeIconConstants.ANGLE_RIGHT, + icon_name=SeedSignerIconConstants.CHEVRON_RIGHT, icon_size=GUIConstants.ICON_INLINE_FONT_SIZE, width=input_button_width, height=input_button_height, diff --git a/src/seedsigner/gui/screens/tools_screens.py b/src/seedsigner/gui/screens/tools_screens.py index c99c2b7a..0b291c01 100644 --- a/src/seedsigner/gui/screens/tools_screens.py +++ b/src/seedsigner/gui/screens/tools_screens.py @@ -140,7 +140,7 @@ class ToolsDiceEntropyEntryScreen(KeyboardScreen): self.rows = 3 self.cols = 3 self.keyboard_font_name = GUIConstants.ICON_FONT_NAME__FONT_AWESOME - self.keyboard_font_size = None # Force auto-scaling to Key height + self.keyboard_font_size = 36 self.keys_charset = "".join([ FontAwesomeIconConstants.DICE_ONE, FontAwesomeIconConstants.DICE_TWO, diff --git a/src/seedsigner/views/psbt_views.py b/src/seedsigner/views/psbt_views.py index 636751d1..b4caf938 100644 --- a/src/seedsigner/views/psbt_views.py +++ b/src/seedsigner/views/psbt_views.py @@ -460,17 +460,16 @@ class PSBTAddressVerificationFailedView(View): def run(self): if self.is_multisig: - title = _("Caution") # TRANSLATOR_NOTE: Variable is either "change" or "self-transfer". - text = _("PSBT's {} address could not be verified with your multisig wallet descriptor.").format(_("change") if self.is_change else _("self-transfer")) + text = _("PSBT's {} address could not be verified from wallet descriptor.").format(_("change") if self.is_change else _("self-transfer")) else: - title = _("Suspicious PSBT") # TRANSLATOR_NOTE: Variable is either "change" or "self-transfer". text = _("PSBT's {} address could not be generated from your seed.").format(_("change") if self.is_change else _("self-transfer")) DireWarningScreen( - title=title, + title=_("Suspicious PSBT"), status_headline=_("Address Verification Failed"), + status_icon_name=SeedSignerIconConstants.ERROR, text=text, button_data=[ButtonOption("Discard PSBT")], show_back_button=False, diff --git a/src/seedsigner/views/scan_views.py b/src/seedsigner/views/scan_views.py index aa83c6bd..dc7d828b 100644 --- a/src/seedsigner/views/scan_views.py +++ b/src/seedsigner/views/scan_views.py @@ -2,6 +2,7 @@ import logging import re from gettext import gettext as _ +from seedsigner.gui.components import SeedSignerIconConstants from seedsigner.helpers.l10n import mark_for_translation as _mft from seedsigner.models.settings import SettingsConstants from seedsigner.views.view import BackStackView, ErrorView, MainMenuView, NotYetImplementedView, View, Destination @@ -163,8 +164,13 @@ class ScanView(View): # For now, don't even try to re-do the attempted operation, just reset and # start everything over. self.controller.resume_main_flow = None + + # TODO: Refactor this warning screen into its own Screen class; the + # screenshot generator is currently manually re-creating it, but it would be + # better if a dedicated Screen could just be instantiated instead. return Destination(ErrorView, view_args=dict( title=_("Error"), + status_icon_name=SeedSignerIconConstants.WARNING, status_headline=_("Unknown QR Type"), text=_("QRCode is invalid or is a data format not yet supported."), button_text=_("Done"), diff --git a/src/seedsigner/views/seed_views.py b/src/seedsigner/views/seed_views.py index 7a9c5121..ae369587 100644 --- a/src/seedsigner/views/seed_views.py +++ b/src/seedsigner/views/seed_views.py @@ -279,8 +279,9 @@ class SeedMnemonicInvalidView(View): def run(self): button_data = [self.EDIT, self.DISCARD] selected_menu_num = self.run_screen( - WarningScreen, + DireWarningScreen, title=_("Invalid Mnemonic!"), + status_icon_name=SeedSignerIconConstants.ERROR, status_headline=None, text=_("Checksum failure; not a valid seed phrase."), show_back_button=False, @@ -1206,6 +1207,7 @@ class SeedBIP85InvalidChildIndexView(View): DireWarningScreen( title=_("BIP-85 Index Error"), show_back_button=False, + status_icon_name=SeedSignerIconConstants.ERROR, status_headline=_("Invalid Child Index"), text=_("BIP-85 Child Index must be between 0 and 2^31-1."), button_data=[ButtonOption("Try Again")] @@ -1366,6 +1368,7 @@ class SeedWordsBackupTestMistakeView(View): selected_menu_num = DireWarningScreen( title=_("Verification Error"), show_back_button=False, + status_icon_name=SeedSignerIconConstants.ERROR, status_headline=status_headline, button_data=button_data, text=text, diff --git a/src/seedsigner/views/view.py b/src/seedsigner/views/view.py index e7673eef..62811458 100644 --- a/src/seedsigner/views/view.py +++ b/src/seedsigner/views/view.py @@ -300,6 +300,7 @@ class NotYetImplementedView(View): class ErrorView(View): title: str = _mft("Error") show_back_button: bool = True + status_icon_name: str = SeedSignerIconConstants.ERROR status_headline: str = None text: str = None button_text: str = None @@ -309,6 +310,7 @@ class ErrorView(View): self.run_screen( WarningScreen, title=self.title, + status_icon_name=self.status_icon_name, status_headline=self.status_headline, text=self.text, button_data=[ButtonOption(self.button_text)], @@ -324,9 +326,14 @@ class NetworkMismatchErrorView(ErrorView): def __post_init__(self): from seedsigner.views.settings_views import SettingsEntryUpdateSelectionView - self.title: str = _("Network Mismatch") - self.show_back_button: bool = False - self.button_text: str = _("Change Setting") + + # TRANSLATOR_NOTE: The network setting (mainnet/testnet/regtest) doesn't match the provided derivation path + self.title = _("Network Mismatch") + self.status_icon_name = SeedSignerIconConstants.WARNING + self.show_back_button = False + + # TRANSLATOR_NOTE: Button option to alter a setting + self.button_text = _("Change Setting") self.next_destination = Destination(SettingsEntryUpdateSelectionView, view_args=dict(attr_name=SettingsConstants.SETTING__NETWORK), clear_history=True) super().__post_init__() @@ -347,6 +354,7 @@ class UnhandledExceptionView(View): self.run_screen( DireWarningScreen, title=_("System Error"), + status_icon_name=SeedSignerIconConstants.ERROR, status_headline=self.error[0], text=self.error[1] + "\n" + self.error[2], allow_text_overflow=True, # Fit what we can, let the rest go off the edges diff --git a/tests/screenshot_generator/generator.py b/tests/screenshot_generator/generator.py index 114f5c68..c82ae5ad 100644 --- a/tests/screenshot_generator/generator.py +++ b/tests/screenshot_generator/generator.py @@ -24,6 +24,7 @@ sys.modules['seedsigner.hardware.microsd'] = MagicMock() patch('PIL.ImageFont.core.HAVE_RAQM', False).start() from seedsigner.controller import Controller +from seedsigner.gui.components import SeedSignerIconConstants from seedsigner.gui.renderer import Renderer from seedsigner.gui.screens.seed_screens import SeedAddPassphraseScreen from seedsigner.gui.toast import BaseToastOverlayManagerThread, RemoveSDCardToastManagerThread, SDCardStateChangeToastManagerThread @@ -359,12 +360,17 @@ def generate_screenshots(locale): ScreenshotConfig(UnhandledExceptionView, dict(error=["IndexError", "line 1, in some_buggy_code.py", "list index out of range"])), ScreenshotConfig(NetworkMismatchErrorView, dict(derivation_path="m/84'/1'/0'")), ScreenshotConfig(OptionDisabledView, dict(settings_attr=SettingsConstants.SETTING__MESSAGE_SIGNING)), - ScreenshotConfig(ErrorView, dict( - title="Error", - status_headline="Unknown QR Type", - text="QRCode is invalid or is a data format not yet supported.", - button_text="Back", - )), + ScreenshotConfig( + ErrorView, + dict( + title="Error", + status_icon_name=SeedSignerIconConstants.WARNING, + status_headline="Unknown QR Type", + text="QRCode is invalid or is a data format not yet supported.", + button_text="Back", + ), + screenshot_name="ScanView__UnknownQRType" + ), ] } From 5e16c984b2132a22fdf1a9c4027887ea92e66a7b Mon Sep 17 00:00:00 2001 From: kdmukai Date: Sun, 19 Jan 2025 10:22:05 -0600 Subject: [PATCH 09/23] Associated changes to translation source strings --- l10n/messages.pot | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/l10n/messages.pot b/l10n/messages.pot index 84ffd5bc..07abe61b 100644 --- a/l10n/messages.pot +++ b/l10n/messages.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: seedsigner 0.8.5-rc1\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2025-01-15 10:45-0600\n" +"POT-Creation-Date: 2025-01-19 10:20-0600\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -36,16 +36,6 @@ msgstr "" msgid "sats" msgstr "" -#. The abbreviated label for the special key on a standard keyboard. -#: src/seedsigner/gui/keyboard.py -msgid "del" -msgstr "" - -#. The abbreviated label for the special key on a standard keyboard. -#: src/seedsigner/gui/keyboard.py -msgid "space" -msgstr "" - #: src/seedsigner/gui/toast.py msgid "" "You can remove\n" @@ -215,7 +205,7 @@ msgstr "" msgid "OK" msgstr "" -#: src/seedsigner/gui/screens/screen.py src/seedsigner/views/psbt_views.py +#: src/seedsigner/gui/screens/screen.py msgid "Caution" msgstr "" @@ -901,13 +891,7 @@ msgstr "" #. Variable is either "change" or "self-transfer". #: src/seedsigner/views/psbt_views.py -msgid "" -"PSBT's {} address could not be verified with your multisig wallet " -"descriptor." -msgstr "" - -#: src/seedsigner/views/psbt_views.py -msgid "Suspicious PSBT" +msgid "PSBT's {} address could not be verified from wallet descriptor." msgstr "" #. Variable is either "change" or "self-transfer". @@ -915,6 +899,10 @@ msgstr "" msgid "PSBT's {} address could not be generated from your seed." msgstr "" +#: src/seedsigner/views/psbt_views.py +msgid "Suspicious PSBT" +msgstr "" + #: src/seedsigner/views/psbt_views.py msgid "Address Verification Failed" msgstr "" @@ -1459,10 +1447,13 @@ msgstr "" msgid "Back to Main Menu" msgstr "" +#. The network setting (mainnet/testnet/regtest) doesn't match the provided +#. derivation path #: src/seedsigner/views/view.py msgid "Network Mismatch" msgstr "" +#. Button option to alter a setting #: src/seedsigner/views/view.py msgid "Change Setting" msgstr "" From 7edcd335952fb4453c3f9029381510bd938a2616 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 09:42:35 -0600 Subject: [PATCH 10/23] Improve DireWarning vs Error usage and color consistency --- src/seedsigner/gui/screens/screen.py | 19 ++++++++++++++++++- src/seedsigner/views/psbt_views.py | 1 - src/seedsigner/views/view.py | 10 +++++----- 3 files changed, 23 insertions(+), 7 deletions(-) diff --git a/src/seedsigner/gui/screens/screen.py b/src/seedsigner/gui/screens/screen.py index aa50f88e..47f6645e 100644 --- a/src/seedsigner/gui/screens/screen.py +++ b/src/seedsigner/gui/screens/screen.py @@ -1013,9 +1013,12 @@ class WarningEdgesMixin: @dataclass class WarningScreen(WarningEdgesMixin, LargeIconStatusScreen): + """ + Exclamation point icon + yellow WARNING color + """ title: str = _mft("Caution") status_icon_name: str = SeedSignerIconConstants.WARNING - status_color: str = "yellow" + status_color: str = GUIConstants.WARNING_COLOR status_headline: str = _mft("Privacy Leak!") # The colored text under the alert icon button_data: list = field(default_factory=lambda: [ButtonOption("I Understand")]) @@ -1023,11 +1026,25 @@ class WarningScreen(WarningEdgesMixin, LargeIconStatusScreen): @dataclass class DireWarningScreen(WarningScreen): + """ + Exclamation point icon + orange DIRE_WARNING color + """ status_headline: str = _mft("Classified Info!") # The colored text under the alert icon status_color: str = GUIConstants.DIRE_WARNING_COLOR +@dataclass +class ErrorScreen(WarningScreen): + """ + X icon + red ERROR color + """ + title: str = _mft("Error") + status_icon_name: str = SeedSignerIconConstants.ERROR + status_color: str = GUIConstants.ERROR_COLOR + + + @dataclass class ResetScreen(BaseTopNavScreen): def __post_init__(self): diff --git a/src/seedsigner/views/psbt_views.py b/src/seedsigner/views/psbt_views.py index b4caf938..b39c9367 100644 --- a/src/seedsigner/views/psbt_views.py +++ b/src/seedsigner/views/psbt_views.py @@ -469,7 +469,6 @@ class PSBTAddressVerificationFailedView(View): DireWarningScreen( title=_("Suspicious PSBT"), status_headline=_("Address Verification Failed"), - status_icon_name=SeedSignerIconConstants.ERROR, text=text, button_data=[ButtonOption("Discard PSBT")], show_back_button=False, diff --git a/src/seedsigner/views/view.py b/src/seedsigner/views/view.py index 62811458..66c3a229 100644 --- a/src/seedsigner/views/view.py +++ b/src/seedsigner/views/view.py @@ -5,7 +5,7 @@ from typing import Type from seedsigner.helpers.l10n import mark_for_translation as _mft from seedsigner.gui.components import SeedSignerIconConstants from seedsigner.gui.screens import RET_CODE__POWER_BUTTON, RET_CODE__BACK_BUTTON -from seedsigner.gui.screens.screen import BaseScreen, ButtonOption, DireWarningScreen, LargeButtonScreen, PowerOffScreen, PowerOffNotRequiredScreen, ResetScreen, WarningScreen +from seedsigner.gui.screens.screen import BaseScreen, ButtonOption, LargeButtonScreen, WarningScreen, ErrorScreen from seedsigner.models.settings import Settings, SettingsConstants from seedsigner.models.settings_definition import SettingsDefinition from seedsigner.models.threads import BaseThread @@ -245,6 +245,7 @@ class PowerOptionsView(View): class RestartView(View): def run(self): + from seedsigner.gui.screens.screen import ResetScreen thread = RestartView.DoResetThread() thread.start() self.run_screen(ResetScreen) @@ -270,6 +271,7 @@ class RestartView(View): class PowerOffView(View): def run(self): + from seedsigner.gui.screens.screen import PowerOffNotRequiredScreen self.run_screen(PowerOffNotRequiredScreen) return Destination(BackStackView) @@ -308,7 +310,7 @@ class ErrorView(View): def run(self): self.run_screen( - WarningScreen, + ErrorScreen, title=self.title, status_icon_name=self.status_icon_name, status_headline=self.status_headline, @@ -349,12 +351,10 @@ class NetworkMismatchErrorView(ErrorView): class UnhandledExceptionView(View): error: list[str] - def run(self): self.run_screen( - DireWarningScreen, + ErrorScreen, title=_("System Error"), - status_icon_name=SeedSignerIconConstants.ERROR, status_headline=self.error[0], text=self.error[1] + "\n" + self.error[2], allow_text_overflow=True, # Fit what we can, let the rest go off the edges From c0fe6766b22497d9adda3efafbe25bfeb855a6c8 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 09:43:41 -0600 Subject: [PATCH 11/23] add `ScanInvalidQRTypeView` --- src/seedsigner/views/scan_views.py | 35 ++++++++++++++++--------- tests/screenshot_generator/generator.py | 19 +++----------- tests/test_flows_seed.py | 2 +- 3 files changed, 27 insertions(+), 29 deletions(-) diff --git a/src/seedsigner/views/scan_views.py b/src/seedsigner/views/scan_views.py index dc7d828b..54097c3e 100644 --- a/src/seedsigner/views/scan_views.py +++ b/src/seedsigner/views/scan_views.py @@ -2,10 +2,10 @@ import logging import re from gettext import gettext as _ -from seedsigner.gui.components import SeedSignerIconConstants from seedsigner.helpers.l10n import mark_for_translation as _mft from seedsigner.models.settings import SettingsConstants from seedsigner.views.view import BackStackView, ErrorView, MainMenuView, NotYetImplementedView, View, Destination +from seedsigner.gui.screens.screen import ButtonOption logger = logging.getLogger(__name__) @@ -164,18 +164,7 @@ class ScanView(View): # For now, don't even try to re-do the attempted operation, just reset and # start everything over. self.controller.resume_main_flow = None - - # TODO: Refactor this warning screen into its own Screen class; the - # screenshot generator is currently manually re-creating it, but it would be - # better if a dedicated Screen could just be instantiated instead. - return Destination(ErrorView, view_args=dict( - title=_("Error"), - status_icon_name=SeedSignerIconConstants.WARNING, - status_headline=_("Unknown QR Type"), - text=_("QRCode is invalid or is a data format not yet supported."), - button_text=_("Done"), - next_destination=Destination(MainMenuView, clear_history=True), - )) + return Destination(ScanInvalidQRTypeView) return Destination(MainMenuView) @@ -218,3 +207,23 @@ class ScanAddressView(ScanView): @property def is_valid_qr_type(self): return self.decoder.is_address + + + +class ScanInvalidQRTypeView(View): + def run(self): + from seedsigner.gui.screens import WarningScreen + + # TODO: This screen says "Error" but is intentionally using the WarningScreen in + # order to avoid the perception that something is broken on our end. This should + # either change to use the red ErrorScreen or the "Error" title should be + # changed to something softer. + self.run_screen( + WarningScreen, + title=_("Error"), + status_headline=_("Unknown QR Type"), + text=_("QRCode is invalid or is a data format not yet supported."), + button_data=[ButtonOption("Done")], + ) + + return Destination(MainMenuView, clear_history=True) diff --git a/tests/screenshot_generator/generator.py b/tests/screenshot_generator/generator.py index c82ae5ad..ca697eb9 100644 --- a/tests/screenshot_generator/generator.py +++ b/tests/screenshot_generator/generator.py @@ -24,10 +24,9 @@ sys.modules['seedsigner.hardware.microsd'] = MagicMock() patch('PIL.ImageFont.core.HAVE_RAQM', False).start() from seedsigner.controller import Controller -from seedsigner.gui.components import SeedSignerIconConstants from seedsigner.gui.renderer import Renderer from seedsigner.gui.screens.seed_screens import SeedAddPassphraseScreen -from seedsigner.gui.toast import BaseToastOverlayManagerThread, RemoveSDCardToastManagerThread, SDCardStateChangeToastManagerThread +from seedsigner.gui.toast import RemoveSDCardToastManagerThread, SDCardStateChangeToastManagerThread from seedsigner.hardware.microsd import MicroSD from seedsigner.helpers import embit_utils from seedsigner.models.decode_qr import DecodeQR @@ -37,9 +36,9 @@ from seedsigner.models.seed import Seed from seedsigner.models.settings import Settings from seedsigner.models.settings_definition import SettingsConstants, SettingsDefinition from seedsigner.views import (MainMenuView, PowerOptionsView, RestartView, NotYetImplementedView, UnhandledExceptionView, - psbt_views, seed_views, settings_views, tools_views) + psbt_views, seed_views, settings_views, tools_views, scan_views) from seedsigner.views.screensaver import OpeningSplashView -from seedsigner.views.view import ErrorView, NetworkMismatchErrorView, OptionDisabledView, PowerOffView, View +from seedsigner.views.view import NetworkMismatchErrorView, OptionDisabledView, PowerOffView from .utils import ScreenshotComplete, ScreenshotConfig, ScreenshotRenderer @@ -360,17 +359,7 @@ def generate_screenshots(locale): ScreenshotConfig(UnhandledExceptionView, dict(error=["IndexError", "line 1, in some_buggy_code.py", "list index out of range"])), ScreenshotConfig(NetworkMismatchErrorView, dict(derivation_path="m/84'/1'/0'")), ScreenshotConfig(OptionDisabledView, dict(settings_attr=SettingsConstants.SETTING__MESSAGE_SIGNING)), - ScreenshotConfig( - ErrorView, - dict( - title="Error", - status_icon_name=SeedSignerIconConstants.WARNING, - status_headline="Unknown QR Type", - text="QRCode is invalid or is a data format not yet supported.", - button_text="Back", - ), - screenshot_name="ScanView__UnknownQRType" - ), + ScreenshotConfig(scan_views.ScanInvalidQRTypeView) ] } diff --git a/tests/test_flows_seed.py b/tests/test_flows_seed.py index 490e9f15..2e63e702 100644 --- a/tests/test_flows_seed.py +++ b/tests/test_flows_seed.py @@ -646,7 +646,7 @@ class TestMessageSigningFlows(FlowTest): FlowStep(seed_views.SeedFinalizeView, button_data_selection=seed_views.SeedFinalizeView.FINALIZE), FlowStep(seed_views.SeedOptionsView, button_data_selection=seed_views.SeedOptionsView.SIGN_MESSAGE), FlowStep(scan_views.ScanView, before_run=load_invalid_signmessage_qr), # simulate read message QR; ret val is ignored - FlowStep(ErrorView), + FlowStep(scan_views.ScanInvalidQRTypeView), FlowStep(MainMenuView), ]) From abc96e37fe6b878002c4159643497d3e3a0a0850 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 10:06:05 -0600 Subject: [PATCH 12/23] version up all deprecated CI actions --- .github/workflows/build.yml | 12 ++++++------ .github/workflows/tests.yml | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a0649dc7..3c2de8c8 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -31,7 +31,7 @@ jobs: target: [ "pi0", "pi2", "pi02w", "pi4" ] steps: - name: checkout seedsigner-os - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: "seedsigner/seedsigner-os" # use the os-ref input parameter in case of workflow_dispatch or default to main in case of cron triggers @@ -42,7 +42,7 @@ jobs: fetch-depth: 0 - name: checkout source - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: # ref defaults to repo default-branch=dev (cron) or SHA of event (workflow_dispatch) path: "seedsigner-os/opt/rootfs-overlay/opt" @@ -78,7 +78,7 @@ jobs: ls -la src - name: restore build cache - uses: actions/cache@v3 + uses: actions/cache@v4 # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, # while consuming ~850 MB storage space). with: @@ -113,7 +113,7 @@ jobs: ls -la seedsigner-os/images - name: upload images - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: seedsigner_os_images path: "seedsigner-os/images/*.img" @@ -127,7 +127,7 @@ jobs: needs: build steps: - name: download images - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: seedsigner_os_images path: images @@ -148,7 +148,7 @@ jobs: sha256sum *.img > seedsigner_os.${{ env.source_hash }}.sha256 - name: upload checksums - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: seedsigner_os_images path: "images/*.sha256" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 9fba7af5..20e530ce 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -26,12 +26,12 @@ jobs: python-version: ["3.10", "3.12"] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: # Needs to also pull the seedsigner-translations repo submodules: recursive - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install dependencies @@ -63,7 +63,7 @@ jobs: - name: Coverage report run: coverage report - name: Archive CI Artifacts - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: ci-artifacts path: artifacts/** From 05d0644529968b5d65b63f2cda2ae1f73f6a0eba Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 10:20:30 -0600 Subject: [PATCH 13/23] bugfix: set distinct artifact upload names --- .github/workflows/build.yml | 4 ++-- .github/workflows/tests.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3c2de8c8..4cea156b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -115,7 +115,7 @@ jobs: - name: upload images uses: actions/upload-artifact@v4 with: - name: seedsigner_os_images + name: seedsigner_os_images-${{ matrix.target }} path: "seedsigner-os/images/*.img" if-no-files-found: error # maximum 90 days retention @@ -150,7 +150,7 @@ jobs: - name: upload checksums uses: actions/upload-artifact@v4 with: - name: seedsigner_os_images + name: seedsigner_os_hashes-${{ matrix.target }} path: "images/*.sha256" if-no-files-found: error # maximum 90 days retention diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 20e530ce..9be339c0 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -65,7 +65,7 @@ jobs: - name: Archive CI Artifacts uses: actions/upload-artifact@v4 with: - name: ci-artifacts + name: ci-artifacts-${{ matrix.python-version }} path: artifacts/** retention-days: 10 # Upload also when tests fail. The workflow result (red/green) will From 11965d4b7fa91ecef143fd8bbda5ebee78d1c3b1 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 10:32:53 -0600 Subject: [PATCH 14/23] bugfix: wildcard syntax, download artifact name --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4cea156b..7af6a7e3 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -101,7 +101,7 @@ jobs: - name: rename image run: | cd seedsigner-os/images - mv seedsigner_os*.img seedsigner_os.${{ env.img_version }}.${{ matrix.target }}.img + mv *.img seedsigner_os.${{ env.img_version }}.${{ matrix.target }}.img - name: print sha256sum run: | @@ -129,7 +129,7 @@ jobs: - name: download images uses: actions/download-artifact@v4 with: - name: seedsigner_os_images + name: seedsigner_os_images-${{ matrix.target }} path: images - name: list images From 09007c03ec359b49b89919939ab03e05bacd573a Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 10:48:09 -0600 Subject: [PATCH 15/23] bugfix: revert cache to v3 --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 7af6a7e3..26ecf742 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -78,7 +78,7 @@ jobs: ls -la src - name: restore build cache - uses: actions/cache@v4 + uses: actions/cache@v3 # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, # while consuming ~850 MB storage space). with: From b526d86a63d625e39b45fa5a9b08c583518a280f Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 12:20:01 -0600 Subject: [PATCH 16/23] stick w/cache@v4, but try w/out `--no-clean` --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 26ecf742..e17d03ed 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -78,7 +78,7 @@ jobs: ls -la src - name: restore build cache - uses: actions/cache@v3 + uses: actions/cache@v4 # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, # while consuming ~850 MB storage space). with: @@ -92,7 +92,7 @@ jobs: - name: build run: | cd seedsigner-os/opt - ./build.sh --${{ matrix.target }} --skip-repo --no-clean + ./build.sh --${{ matrix.target }} --skip-repo - name: list image (before rename) run: | From 3966675197ca811bbec2dcb340d117b3838c0eb8 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 12:30:28 -0600 Subject: [PATCH 17/23] Try disabling cache --- .github/workflows/build.yml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e17d03ed..43ce651c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -77,17 +77,17 @@ jobs: ls -la . ls -la src - - name: restore build cache - uses: actions/cache@v4 - # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, - # while consuming ~850 MB storage space). - with: - path: | - ~/.buildroot-ccache/ - seedsigner-os/buildroot_dl - key: build-cache-${{ matrix.target }}-${{ env.builder_hash }} - restore-keys: | - build-cache-${{ matrix.target }}- + # - name: restore build cache + # uses: actions/cache@v4 + # # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, + # # while consuming ~850 MB storage space). + # with: + # path: | + # ~/.buildroot-ccache/ + # seedsigner-os/buildroot_dl + # key: build-cache-${{ matrix.target }}-${{ env.builder_hash }} + # restore-keys: | + # build-cache-${{ matrix.target }}- - name: build run: | From 3e4deb4bda31010d7963ac6ada6f3b5f67f53184 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Thu, 23 Jan 2025 12:45:19 -0600 Subject: [PATCH 18/23] Remove build.yml from PR --- .github/workflows/build.yml | 42 ++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 43ce651c..a0649dc7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -31,7 +31,7 @@ jobs: target: [ "pi0", "pi2", "pi02w", "pi4" ] steps: - name: checkout seedsigner-os - uses: actions/checkout@v4 + uses: actions/checkout@v3 with: repository: "seedsigner/seedsigner-os" # use the os-ref input parameter in case of workflow_dispatch or default to main in case of cron triggers @@ -42,7 +42,7 @@ jobs: fetch-depth: 0 - name: checkout source - uses: actions/checkout@v4 + uses: actions/checkout@v3 with: # ref defaults to repo default-branch=dev (cron) or SHA of event (workflow_dispatch) path: "seedsigner-os/opt/rootfs-overlay/opt" @@ -77,22 +77,22 @@ jobs: ls -la . ls -la src - # - name: restore build cache - # uses: actions/cache@v4 - # # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, - # # while consuming ~850 MB storage space). - # with: - # path: | - # ~/.buildroot-ccache/ - # seedsigner-os/buildroot_dl - # key: build-cache-${{ matrix.target }}-${{ env.builder_hash }} - # restore-keys: | - # build-cache-${{ matrix.target }}- + - name: restore build cache + uses: actions/cache@v3 + # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, + # while consuming ~850 MB storage space). + with: + path: | + ~/.buildroot-ccache/ + seedsigner-os/buildroot_dl + key: build-cache-${{ matrix.target }}-${{ env.builder_hash }} + restore-keys: | + build-cache-${{ matrix.target }}- - name: build run: | cd seedsigner-os/opt - ./build.sh --${{ matrix.target }} --skip-repo + ./build.sh --${{ matrix.target }} --skip-repo --no-clean - name: list image (before rename) run: | @@ -101,7 +101,7 @@ jobs: - name: rename image run: | cd seedsigner-os/images - mv *.img seedsigner_os.${{ env.img_version }}.${{ matrix.target }}.img + mv seedsigner_os*.img seedsigner_os.${{ env.img_version }}.${{ matrix.target }}.img - name: print sha256sum run: | @@ -113,9 +113,9 @@ jobs: ls -la seedsigner-os/images - name: upload images - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v3 with: - name: seedsigner_os_images-${{ matrix.target }} + name: seedsigner_os_images path: "seedsigner-os/images/*.img" if-no-files-found: error # maximum 90 days retention @@ -127,9 +127,9 @@ jobs: needs: build steps: - name: download images - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v3 with: - name: seedsigner_os_images-${{ matrix.target }} + name: seedsigner_os_images path: images - name: list images @@ -148,9 +148,9 @@ jobs: sha256sum *.img > seedsigner_os.${{ env.source_hash }}.sha256 - name: upload checksums - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v3 with: - name: seedsigner_os_hashes-${{ matrix.target }} + name: seedsigner_os_images path: "images/*.sha256" if-no-files-found: error # maximum 90 days retention From 18c13daca8ca4dab85bec9828ea6c37977c33e0f Mon Sep 17 00:00:00 2001 From: Daniel Bast <2790401+dbast@users.noreply.github.com> Date: Thu, 23 Jan 2025 21:50:26 +0100 Subject: [PATCH 19/23] Fix build: Building in Docker Container + update action versions --- .github/workflows/build.yml | 40 ++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a0649dc7..87a407fe 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -31,7 +31,7 @@ jobs: target: [ "pi0", "pi2", "pi02w", "pi4" ] steps: - name: checkout seedsigner-os - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: "seedsigner/seedsigner-os" # use the os-ref input parameter in case of workflow_dispatch or default to main in case of cron triggers @@ -42,7 +42,7 @@ jobs: fetch-depth: 0 - name: checkout source - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: # ref defaults to repo default-branch=dev (cron) or SHA of event (workflow_dispatch) path: "seedsigner-os/opt/rootfs-overlay/opt" @@ -78,7 +78,7 @@ jobs: ls -la src - name: restore build cache - uses: actions/cache@v3 + uses: actions/cache@v4 # Caching reduces the build time to ~50% (currently: ~30 mins instead of ~1 hour, # while consuming ~850 MB storage space). with: @@ -89,10 +89,25 @@ jobs: restore-keys: | build-cache-${{ matrix.target }}- + - name: Create build container + run: | + cd seedsigner-os + docker build -t seedsigner-os-build . + - name: build run: | - cd seedsigner-os/opt - ./build.sh --${{ matrix.target }} --skip-repo --no-clean + mkdir -p \ + ~/.buildroot-ccache \ + seedsigner-os/buildroot_dl + docker run \ + --rm \ + -v "$(pwd)/seedsigner-os/opt:/opt" \ + -v "$(pwd)/seedsigner-os/images:/images" \ + -v "$(pwd)/seedsigner-os/buildroot_dl:/buildroot_dl" \ + -v "${HOME}/.buildroot-ccache:/root/.buildroot-ccache" \ + seedsigner-os-build \ + --${{ matrix.target }} --skip-repo --no-clean + sudo chown -R $USER:$USER seedsigner-os/images seedsigner-os/buildroot_dl ~/.buildroot-ccache/ - name: list image (before rename) run: | @@ -113,9 +128,9 @@ jobs: ls -la seedsigner-os/images - name: upload images - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: - name: seedsigner_os_images + name: seedsigner_os_images-${{ matrix.target }} path: "seedsigner-os/images/*.img" if-no-files-found: error # maximum 90 days retention @@ -127,14 +142,13 @@ jobs: needs: build steps: - name: download images - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: - name: seedsigner_os_images path: images - name: list images run: | - ls -la images + ls -lRa images - name: get seedsigner latest commit hash id: get-seedsigner-hash @@ -145,12 +159,14 @@ jobs: - name: write sha256sum run: | cd images + # each downloaded image is in its own subfolder + find . -name "*.img" -exec mv {} . \; sha256sum *.img > seedsigner_os.${{ env.source_hash }}.sha256 - name: upload checksums - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: - name: seedsigner_os_images + name: seedsigner_os_images_sha256 path: "images/*.sha256" if-no-files-found: error # maximum 90 days retention From 31f2c2292e67df8e5a63c64356e2e24ffc87bf73 Mon Sep 17 00:00:00 2001 From: kdmukai Date: Tue, 28 Jan 2025 09:42:28 -0600 Subject: [PATCH 20/23] Sync submodule commits; update version display string to v0.8.5 --- seedsigner-screenshots | 2 +- src/seedsigner/controller.py | 2 +- src/seedsigner/resources/seedsigner-translations | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/seedsigner-screenshots b/seedsigner-screenshots index f3139067..8e97151b 160000 --- a/seedsigner-screenshots +++ b/seedsigner-screenshots @@ -1 +1 @@ -Subproject commit f313906766347bbcc99a167d434d055407c34dd7 +Subproject commit 8e97151b7e0658dcffc02e7551e1606abcc572bf diff --git a/src/seedsigner/controller.py b/src/seedsigner/controller.py index 5d34fa29..7505408c 100644 --- a/src/seedsigner/controller.py +++ b/src/seedsigner/controller.py @@ -99,7 +99,7 @@ class Controller(Singleton): rather than at the top in order avoid circular imports. """ - VERSION = "0.8.5-rc1" + VERSION = "0.8.5" # Declare class member vars with type hints to enable richer IDE support throughout # the code. diff --git a/src/seedsigner/resources/seedsigner-translations b/src/seedsigner/resources/seedsigner-translations index 281a3dab..265f4e38 160000 --- a/src/seedsigner/resources/seedsigner-translations +++ b/src/seedsigner/resources/seedsigner-translations @@ -1 +1 @@ -Subproject commit 281a3dab8304ab17eef57fb6b1a7170ae53c204b +Subproject commit 265f4e38712f0ec68de905fe1ae300c9564d7ae7 From 03b6044f88b741b257a67e4935955ff4ba97cc9c Mon Sep 17 00:00:00 2001 From: kdmukai Date: Tue, 28 Jan 2025 13:39:36 -0600 Subject: [PATCH 21/23] Allow ANYCLICK in image entropy flow --- l10n/messages.pot | 39 ++++++++++--------- src/seedsigner/gui/screens/tools_screens.py | 9 +++-- .../resources/seedsigner-translations | 2 +- 3 files changed, 26 insertions(+), 24 deletions(-) diff --git a/l10n/messages.pot b/l10n/messages.pot index 07abe61b..666c12cc 100644 --- a/l10n/messages.pot +++ b/l10n/messages.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: seedsigner 0.8.5-rc1\n" "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n" -"POT-Creation-Date: 2025-01-19 10:20-0600\n" +"POT-Creation-Date: 2025-01-28 13:28-0600\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -221,6 +221,11 @@ msgstr "" msgid "Classified Info!" msgstr "" +#: src/seedsigner/gui/screens/screen.py src/seedsigner/views/scan_views.py +#: src/seedsigner/views/view.py +msgid "Error" +msgstr "" + #: src/seedsigner/gui/screens/screen.py msgid "Restarting" msgstr "" @@ -506,7 +511,7 @@ msgid "Home" msgstr "" #: src/seedsigner/gui/screens/tools_screens.py -msgid "click joystick" +msgid "click a button" msgstr "" #. A prompt to the user to either accept or reshoot the image @@ -943,23 +948,6 @@ msgstr "" msgid "Wrong QR Type" msgstr "" -#: src/seedsigner/views/scan_views.py src/seedsigner/views/view.py -msgid "Error" -msgstr "" - -#: src/seedsigner/views/scan_views.py -msgid "Unknown QR Type" -msgstr "" - -#: src/seedsigner/views/scan_views.py -msgid "QRCode is invalid or is a data format not yet supported." -msgstr "" - -#: src/seedsigner/views/scan_views.py src/seedsigner/views/seed_views.py -#: src/seedsigner/views/view.py -msgid "Done" -msgstr "" - #: src/seedsigner/views/scan_views.py src/seedsigner/views/seed_views.py msgid "Scan PSBT" msgstr "" @@ -992,6 +980,19 @@ msgstr "" msgid "Expected an address QR" msgstr "" +#: src/seedsigner/views/scan_views.py +msgid "Unknown QR Type" +msgstr "" + +#: src/seedsigner/views/scan_views.py +msgid "QRCode is invalid or is a data format not yet supported." +msgstr "" + +#: src/seedsigner/views/scan_views.py src/seedsigner/views/seed_views.py +#: src/seedsigner/views/view.py +msgid "Done" +msgstr "" + #. This is on the opening splash screen, displayed above the HRF logo #: src/seedsigner/views/screensaver.py msgid "With support from:" diff --git a/src/seedsigner/gui/screens/tools_screens.py b/src/seedsigner/gui/screens/tools_screens.py index 0b291c01..8fab9a16 100644 --- a/src/seedsigner/gui/screens/tools_screens.py +++ b/src/seedsigner/gui/screens/tools_screens.py @@ -43,8 +43,8 @@ class ToolsImageEntropyLivePreviewScreen(BaseScreen): time.sleep(0.01) continue - # Check for joystick click to take final entropy image - if self.hw_inputs.check_for_low(HardwareButtonsConstants.KEY_PRESS): + # Check for ANYCLICK to take final entropy image + if self.hw_inputs.check_for_low(keys=HardwareButtonsConstants.KEYS__ANYCLICK): # Have to manually update last input time since we're not in a wait_for loop self.hw_inputs.update_last_input_time() self.camera.stop_video_stream_mode() @@ -77,7 +77,7 @@ class ToolsImageEntropyLivePreviewScreen(BaseScreen): int(self.renderer.canvas_width/2), self.renderer.canvas_height - GUIConstants.EDGE_PADDING ), - text="< " + _("back") + " | " + _("click joystick"), # TODO: Render with UI elements instead of text + text="< " + _("back") + " | " + _("click a button"), # TODO: Render with UI elements instead of text fill=GUIConstants.BODY_FONT_COLOR, font=instructions_font, stroke_width=4, @@ -123,7 +123,8 @@ class ToolsImageEntropyFinalImageScreen(BaseScreen): ) self.renderer.show_image() - input = self.hw_inputs.wait_for([HardwareButtonsConstants.KEY_LEFT, HardwareButtonsConstants.KEY_RIGHT]) + # LEFT = reshoot, RIGHT / ANYCLICK = accept + input = self.hw_inputs.wait_for([HardwareButtonsConstants.KEY_LEFT, HardwareButtonsConstants.KEY_RIGHT] + HardwareButtonsConstants.KEYS__ANYCLICK) if input == HardwareButtonsConstants.KEY_LEFT: return RET_CODE__BACK_BUTTON diff --git a/src/seedsigner/resources/seedsigner-translations b/src/seedsigner/resources/seedsigner-translations index 265f4e38..feebe3b4 160000 --- a/src/seedsigner/resources/seedsigner-translations +++ b/src/seedsigner/resources/seedsigner-translations @@ -1 +1 @@ -Subproject commit 265f4e38712f0ec68de905fe1ae300c9564d7ae7 +Subproject commit feebe3b44c385dfe81c14116ed6c097522313352 From db3074b4af045cf482660c0e58744d12222f5d6a Mon Sep 17 00:00:00 2001 From: kdmukai Date: Tue, 28 Jan 2025 15:00:12 -0600 Subject: [PATCH 22/23] Updating ref to 0.8.5 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 84757b94..7f34e326 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,7 +13,7 @@ description = "Build an offline, airgapped Bitcoin signing device for less than name = "seedsigner" readme = "README.md" requires-python = ">=3.10" -version = "0.8.5-rc1" +version = "0.8.5" [project.urls] "Bug Tracker" = "https://github.com/SeedSigner/seedsigner/issues" From 40e0adac741dca21ce33998fcb3bdb8c6da70d0c Mon Sep 17 00:00:00 2001 From: kdmukai Date: Tue, 28 Jan 2025 15:29:53 -0600 Subject: [PATCH 23/23] Sync submodule to minor ES update to fit live preview screens --- src/seedsigner/resources/seedsigner-translations | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/seedsigner/resources/seedsigner-translations b/src/seedsigner/resources/seedsigner-translations index feebe3b4..10ee02ae 160000 --- a/src/seedsigner/resources/seedsigner-translations +++ b/src/seedsigner/resources/seedsigner-translations @@ -1 +1 @@ -Subproject commit feebe3b44c385dfe81c14116ed6c097522313352 +Subproject commit 10ee02ae23156ab97600a407b2da66b84e89d29d