trezorlib API improvements

common/protob/messages-management.proto

@@ -651,7 +651,7 @@ message UnlockPath {
  * @next GetAddress
  */
 message UnlockedPathRequest {
-    optional bytes mac = 1;            // authentication code for future UnlockPath calls
+    required bytes mac = 1;            // authentication code for future UnlockPath calls
 }
 
 /**

common/protob/messages-monero.proto

@@ -98,7 +98,7 @@ message MoneroGetAddress {
  * @end
  */
 message MoneroAddress {
-    optional bytes address = 1;
+    required bytes address = 1;
 }
 
 /**
@@ -117,8 +117,8 @@ message MoneroGetWatchKey {
  * @end
  */
 message MoneroWatchKey {
-    optional bytes watch_key = 1;
-    optional bytes address = 2;
+    required bytes watch_key = 1;
+    required bytes address = 2;
 }
 
 /**

core/src/trezor/ui/layouts/bolt/reset.py

@@ -372,7 +372,7 @@ async def show_share_confirmation_success(
             )
             text = TR.reset__continue_with_next_share
 
-    return await show_success("success_recovery", text, subheader)
+    return await show_success("success_share_confirm", text, subheader)
 
 
 async def show_share_confirmation_failure() -> None:

core/src/trezor/ui/layouts/quicksilver/reset.py

@@ -372,7 +372,7 @@ async def show_share_confirmation_success(
                 )
             )
 
-    await show_success("success_recovery", title, subheader=footer_description)
+    await show_success("success_share_confirm", title, subheader=footer_description)
 
 
 def show_share_confirmation_failure() -> Awaitable[None]:

core/src/trezor/ui/layouts/samson/reset.py

@@ -339,7 +339,7 @@ async def show_share_confirmation_success(
             )
             text = TR.reset__continue_with_next_share
 
-    return await show_success("success_recovery", text, subheader)
+    return await show_success("success_share_confirm", text, subheader)
 
 
 async def show_share_confirmation_failure() -> None:

docs/developers/hello_world_feature_TT.md

@@ -154,7 +154,6 @@ if TYPE_CHECKING:
     from .protobuf import MessageType
 
 
-@expect(messages.HelloWorldResponse, field="text", ret_type=str)
 def say_hello(
     client: "TrezorClient",
     name: str,
@@ -166,8 +165,9 @@ def say_hello(
             name=name,
             amount=amount,
             show_display=show_display,
-        )
-    )
+        ),
+        expect=messages.HelloWorldResponse,
+    ).text
 ```
 
 Code above is sending `HelloWorldRequest` into Trezor and is expecting to get `HelloWorldResponse` back (from which it extracts the `text` string as a response).

legacy/firmware/fsm_msg_coin.h

@@ -862,7 +862,6 @@ void fsm_msgUnlockPath(const UnlockPath *msg) {
 
   unlock_path = msg->address_n[0];
   resp->mac.size = SHA256_DIGEST_LENGTH;
-  resp->has_mac = true;
   msg_write(MessageType_MessageType_UnlockedPathRequest, resp);
   layoutHome();
 }

python/.changelog.d/4155.added

@@ -1 +1 @@
-Added support for entropy check workflow in device.reset().
+Added support for entropy check workflow in `device.reset()`.

python/.changelog.d/4464.added

@@ -0,0 +1 @@
+Introduced `device.setup()` as a cleaner upgrade to `device.reset()`.

python/.changelog.d/4464.added.1

@@ -0,0 +1 @@
+Added an `expect` argument to `TrezorClient.call()`, to enforce the returned message type.

python/.changelog.d/4464.deprecated

@@ -0,0 +1 @@
+`device.reset()` is deprecated, migrate to `device.setup()`

python/.changelog.d/4464.deprecated.1

@@ -0,0 +1 @@
+String return values are deprecated in functions where the semantic result is a success (specifically those that were returning the message from Trezor's `Success` response). Type annotations are updated to `str | None`, and in a future release those functions will be returning `None` on success, or raise an exception on a failure.

python/.changelog.d/4464.deprecated.2

@@ -0,0 +1 @@
+`@expect` decorator is deprecated -- use `TrezorClient.call(expect=...)` instead.

python/.changelog.d/4464.deprecated.3

@@ -0,0 +1 @@
+Return value of `device.recover()` is deprecated. In the future, this function will return `None`.

python/.changelog.d/4464.incompatible

@@ -0,0 +1 @@
+Return values in `solana` module were changed from the wrapping protobuf messages to the raw inner values (`str` for address, `bytes` for pubkey / signature).

python/.changelog.d/4464.incompatible.1

@@ -0,0 +1 @@
+`trezorctl device` commands whose default result is a success will not print anything to stdout anymore, in line with Unix philosophy.

python/src/trezorlib/benchmark.py

@@ -17,20 +17,18 @@
 from typing import TYPE_CHECKING
 
 from . import messages
-from .tools import expect
 
 if TYPE_CHECKING:
     from .client import TrezorClient
-    from .protobuf import MessageType
 
 
-@expect(messages.BenchmarkNames)
 def list_names(
     client: "TrezorClient",
-) -> "MessageType":
-    return client.call(messages.BenchmarkListNames())
+) -> messages.BenchmarkNames:
+    return client.call(messages.BenchmarkListNames(), expect=messages.BenchmarkNames)
 
 
-@expect(messages.BenchmarkResult)
-def run(client: "TrezorClient", name: str) -> "MessageType":
-    return client.call(messages.BenchmarkRun(name=name))
+def run(client: "TrezorClient", name: str) -> messages.BenchmarkResult:
+    return client.call(
+        messages.BenchmarkRun(name=name), expect=messages.BenchmarkResult
+    )

python/src/trezorlib/binance.py

@@ -18,35 +18,34 @@
 
 from . import messages
 from .protobuf import dict_to_proto
-from .tools import expect, session
+from .tools import session
 
 if TYPE_CHECKING:
     from .client import TrezorClient
-    from .protobuf import MessageType
     from .tools import Address
 
 
-@expect(messages.BinanceAddress, field="address", ret_type=str)
 def get_address(
     client: "TrezorClient",
     address_n: "Address",
     show_display: bool = False,
     chunkify: bool = False,
-) -> "MessageType":
+) -> str:
     return client.call(
         messages.BinanceGetAddress(
             address_n=address_n, show_display=show_display, chunkify=chunkify
-        )
-    )
+        ),
+        expect=messages.BinanceAddress,
+    ).address
 
 
-@expect(messages.BinancePublicKey, field="public_key", ret_type=bytes)
 def get_public_key(
     client: "TrezorClient", address_n: "Address", show_display: bool = False
-) -> "MessageType":
+) -> bytes:
     return client.call(
-        messages.BinanceGetPublicKey(address_n=address_n, show_display=show_display)
-    )
+        messages.BinanceGetPublicKey(address_n=address_n, show_display=show_display),
+        expect=messages.BinancePublicKey,
+    ).public_key
 
 
 @session
@@ -60,13 +59,7 @@ def sign_tx(
     tx_msg["chunkify"] = chunkify
     envelope = dict_to_proto(messages.BinanceSignTx, tx_msg)
 
-    response = client.call(envelope)
-
-    if not isinstance(response, messages.BinanceTxRequest):
-        raise RuntimeError(
-            "Invalid response, expected BinanceTxRequest, received "
-            + type(response).__name__
-        )
+    client.call(envelope, expect=messages.BinanceTxRequest)
 
     if "refid" in msg:
         msg = dict_to_proto(messages.BinanceCancelMsg, msg)
@@ -77,12 +70,4 @@ def sign_tx(
     else:
         raise ValueError("can not determine msg type")
 
-    response = client.call(msg)
-
-    if not isinstance(response, messages.BinanceSignedTx):
-        raise RuntimeError(
-            "Invalid response, expected BinanceSignedTx, received "
-            + type(response).__name__
-        )
-
-    return response
+    return client.call(msg, expect=messages.BinanceSignedTx)