Introduce N4W1 backup/recovery flows #6799
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
|
|
||
| import storage.recovery as storage_recovery | ||
| import storage.recovery_shares as storage_recovery_shares | ||
| from trezor import TR, utils | ||
| from trezor.ui.layouts.recovery import ( # noqa: F401 | ||
| request_word_count, | ||
| show_already_added, | ||
|
|
@@ -278,12 +278,141 @@ async def request_mnemonic(self) -> str | None: | |
| return None | ||
|
|
||
|
|
||
| if not utils.USE_N4W1: | ||
|
|
||
| async def choose_handler(method: BackupMethod | None) -> type[RecoveryHandler]: | ||
| from trezor.enums import BackupMethod | ||
|
|
||
| if method is not BackupMethod.Display and __debug__: | ||
| from trezor import log | ||
|
|
||
| log.warning(__name__, "Unsupported backup method: %s", method) | ||
|
|
||
|
romanz marked this conversation as resolved.
|
||
| return _DisplayHandler | ||
|
|
||
| else: | ||
|
|
||
| if TYPE_CHECKING: | ||
| from trezor.messages import BackupMethod | ||
|
|
||
| from .recover import Slip39State | ||
|
|
||
| async def choose_handler(method: BackupMethod | None) -> type[RecoveryHandler]: | ||
| from trezor.enums import BackupMethod | ||
|
|
||
| if method is None: | ||
| from trezor.ui.layouts.recovery import choose_method | ||
|
|
||
| method = await choose_method(TR.recovery__title, TR.backup__type_have) | ||
|
|
||
| if method is BackupMethod.N4W1: | ||
| return _N4W1Handler | ||
|
|
||
| if method not in (None, BackupMethod.Display): | ||
| from trezor import log | ||
|
|
||
| if __debug__: | ||
| log.warning(__name__, "Unsupported backup method: %s", method) | ||
|
|
||
| return _DisplayHandler | ||
|
|
||
| class RetryRead(Exception): | ||
| def __init__(self, msg: str) -> None: | ||
| self.msg = msg | ||
|
|
||
| async def _read_share() -> str: | ||
| from apps.debug import n4w1_mock | ||
|
|
||
| with n4w1_mock.ctx as ctx: | ||
| # returns `None` on cancellation or retriable error. | ||
| await ctx.confirm_connect( | ||
| title=TR.recovery__title, | ||
| description=TR.n4w1__hold_next, | ||
| button=TR.n4w1__footer_next, | ||
| br_name="backup_read", | ||
| ) | ||
| # continue N4W1 communication (the tag is connected) | ||
|
|
||
| # TODO(N4W1): animate during read? | ||
| if (blob := await ctx.read(key="mnemonic")) is None: | ||
| raise RetryRead(TR.n4w1__err_empty) | ||
|
|
||
| # TODO(N4W1): use protobuf? | ||
| blob = bytes(blob) | ||
|
Member
There was a problem hiding this comment. Why is the
Contributor
Author
There was a problem hiding this comment.
I can switch to use OTOH, trezor-firmware/core/embed/rust/src/protobuf/decode.rs Lines 229 to 233 in 563284b
Contributor
Author
There was a problem hiding this comment.
We can use https://www.notion.so/satoshilabs/Firmware-workpage-WIP-4e58d783efbb41748d599df35053a40a?source=copy_link#28aa30d2d75049bfadcc6e92ad09f2ed for encoding the mnemonic - WDYT?
Member
There was a problem hiding this comment.
ah, didn't realize -
sounds good!
Contributor
Author
There was a problem hiding this comment.
Opened an issue for defining the storage format -> #6876 |
||
| try: | ||
| return blob.decode() | ||
| except ValueError: | ||
| raise RetryRead(TR.n4w1__err_damaged) | ||
|
|
||
| class _N4W1Handler: | ||
| def __init__( | ||
| self, | ||
| recovery_type: RecoveryType, | ||
| slip39_state: Slip39State | None, | ||
| ) -> None: | ||
| super().__init__() | ||
| self.recovery_type = recovery_type | ||
| # `slip39_state is None` indicates that we are (re)starting the first recovery step. | ||
| self.slip39_state = slip39_state | ||
|
|
||
| @classmethod | ||
| async def load(cls, recovery_type: RecoveryType) -> "RecoveryHandler": | ||
| return cls(recovery_type, load_slip39_state()) | ||
|
|
||
| async def show_state(self, is_retry: bool) -> None: | ||
| if is_retry or self.slip39_state is None: | ||
| # don't show recovery state on retries and before the first share is entered | ||
| return | ||
| word_count = self.slip39_state[0] | ||
| await _request_share_first_screen(word_count, self.recovery_type) | ||
|
|
||
| async def request_mnemonic(self) -> str | None: | ||
| """Return the mnemonic or `None` on cancellation/validation error.""" | ||
| import trezorui_api | ||
| from trezor.ui.layouts.common import raise_if_not_confirmed | ||
|
|
||
| while True: | ||
| try: | ||
| share = await _read_share() | ||
| break | ||
| except RetryRead as exc: | ||
| await raise_if_not_confirmed( | ||
| trezorui_api.show_warning( | ||
| title=TR.words__important, | ||
| button=TR.buttons__continue, | ||
| description=exc.msg, | ||
| danger=True, | ||
| ), | ||
| br_name="recovery_retry", | ||
| ) | ||
| # wait for a new N4W1 tag | ||
| continue | ||
|
|
||
| return await self.check_words(share) | ||
|
|
||
| async def check_words(self, share: str) -> str | None: | ||
| from trezor.ui.layouts.progress import progress | ||
|
|
||
| from .word_validity import WordValidityResult, check | ||
|
|
||
| # Can be `None` when checking the first share. | ||
| backup_type = self.slip39_state and self.slip39_state[1] | ||
| share_words = share.split(" ") | ||
|
|
||
| progress_obj = progress(description=TR.n4w1__reading) | ||
| progress_obj.start() | ||
|
|
||
| try: | ||
| # Re-verify mnemonic prefixes: | ||
| steps = len(share_words) | ||
| for prefix_len in range(1, 1 + steps): | ||
| progress_obj.report((1000 * prefix_len) // steps) | ||
| check(backup_type, partial_mnemonic=share_words[:prefix_len]) | ||
|
|
||
| return share | ||
| except WordValidityResult as exc: | ||
| # if they were invalid or some checks failed we continue and request them again | ||
| await exc.show_error() | ||
| return None | ||
| finally: | ||
| progress_obj.stop() | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.