trezorlib API improvements #4490

matejcik · 2025-01-10T13:46:46Z

the following have been implemented in trezorlib:

new exception UnexpectedMessageError to raise when Trezor sends a, well, unexpected message
client.call(msg, expect=SomeType) will raise UnexpectedMessageError whenever expect is not met, analogous to context.call() in core
all of trezorlib now uses this mechanism to enforce expected responses
this is type-safe and fully deprecates the @expect decorator, so that has been deprecated & all usages removed from trezorlib
functions (mostly) in trezorlib.device, which were returning the string from Success(message="...") have been changed to return str | None, and emit a deprecation warning when someone so much as peeks at the resulting str. We'll change them to -> None in v0.14 or maybe v0.15.
function trezorlib.device.recover was returning a Success instance!! 🙄 got the same treatment, still returns an object that kind of looks like a Success but emits deprecation warnings if you touch it.
trezorlib CLI calls using these functions were modified so that they don't print the return value anymore. That's the Unix convention: on success, don't print anything.
a couple protobuf fields coming from Trezor to device were changed to required
changed device.reset to a deprecated kind-of-like-an-alias to newly introduced device.setup.
there is no more separation between reset and reset_entropy_check: the entropy check is an integral part of device.setup, and by default the function will pick a random number of entropy check rounds
device.setup accepts a private argument _get_entropy() which makes it easier to supply external entropy when needed (such as in tests)
tests were updated to deal with these changes
added testcases that check expected_responses for the entropy check flow

github-actions · 2025-01-10T13:48:42Z

core UI changes	device test	click test	persistence test
T2T1 Model T	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3B1 Safe 3	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
T3T1 Safe 5	test(screens) main(screens)	test(screens) main(screens)	test(screens) main(screens)
All	main(screens)

[no changelog]

it's a Python class that emits a DeprecationWarning if you try to use it for almost anything (two exceptions that can't be overriden from the wrapper: * isinstance(depr, SomeOtherClass) * depr is None) we will return instances of this class to indicate that a return value of something will be going away

this deprecates `device.reset()`, and moves the new arguments to `device.setup()`. Also it changes default backup type on core devices to SLIP39-single, same as Suite, and randomizes the number of entropy check rounds, if not provided from outside.

fixes #4464

[no changelog]

romanz

Looks good, added some questions and suggestions:

python/src/trezorlib/client.py

python/src/trezorlib/device.py

python/src/trezorlib/btc.py

python/src/trezorlib/device.py

python/src/trezorlib/stellar.py

tests/device_tests/reset_recovery/test_reset_bip39_t2.py

python/src/trezorlib/tools.py

romanz · 2025-01-14T17:52:53Z

python/src/trezorlib/tools.py

-    else:
-        # - for other types (we assume it's MessageType so a user-defined class)
-        # assign __class__ directly
+    elif isinstance(value, MessageType):


from .protobuf import MessageType should be moved outside of if TYPE_CHECKING:, right?
https://github.com/trezor/trezor-firmware/actions/runs/12768808281/job/35590249650?pr=4490#step:6:473

trezor-firmware/python/src/trezorlib/tools.py

Lines 43 to 52 in f99c9f4

if TYPE_CHECKING:

# Needed to enforce a return value from decorators

# More details: https://www.python.org/dev/peps/pep-0612/

from typing import TypeVar

from typing_extensions import Concatenate, ParamSpec

from . import client

from .messages import Success

from .protobuf import MessageType

matejcik self-assigned this Jan 10, 2025

matejcik requested a review from prusnak as a code owner January 10, 2025 13:46

matejcik added the translations Put this label on a PR to run tests in all languages label Jan 10, 2025

matejcik mentioned this pull request Jan 13, 2025

Introduce Nostr #4436

Open

feat(python): introduce expect argument to client.call

de7419c

matejcik force-pushed the matejcik/entropy-check-python branch from 6450448 to de9174a Compare January 13, 2025 11:16

matejcik marked this pull request as draft January 13, 2025 12:13

matejcik added 9 commits January 13, 2025 15:24

fix(all): make more protobuf fields required

f78b833

[no changelog]

deprecation(python): deprecate @expect

8657964

refactor(python): replace usages of @expect

ab63f30

style(python): improve type hints for input flows

463ce35

fix(tests): update tests for newly introduced device.setup()

a045bcb

fix(tests): implement expected responses for entropy check

940f9e6

fixes #4464

fix(core): improve ButtonRequest.name in backup confirmation

f787013

[no changelog]

matejcik force-pushed the matejcik/entropy-check-python branch from de9174a to f787013 Compare January 13, 2025 14:27

fixup! feat(python): introduce a deprecation helper

8392b2a

matejcik marked this pull request as ready for review January 13, 2025 14:49

matejcik requested a review from romanz January 13, 2025 14:49

romanz approved these changes Jan 14, 2025

View reviewed changes

fixup! refactor(python): replace usages of @expect

f99c9f4

romanz reviewed Jan 14, 2025

View reviewed changes

fixup! fixup! refactor(python): replace usages of @expect

ff33167

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

trezorlib API improvements #4490

trezorlib API improvements #4490

matejcik commented Jan 10, 2025

github-actions bot commented Jan 10, 2025 •

edited

Loading

romanz left a comment

romanz Jan 14, 2025

	if TYPE_CHECKING:
	# Needed to enforce a return value from decorators
	# More details: https://www.python.org/dev/peps/pep-0612/
	from typing import TypeVar

	from typing_extensions import Concatenate, ParamSpec

	from . import client
	from .messages import Success
	from .protobuf import MessageType

trezorlib API improvements #4490

Are you sure you want to change the base?

trezorlib API improvements #4490

Conversation

matejcik commented Jan 10, 2025

github-actions bot commented Jan 10, 2025 • edited Loading

romanz left a comment

Choose a reason for hiding this comment

romanz Jan 14, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 10, 2025 •

edited

Loading