Fix BITCOIN_ONLY version issue. by lihuanhuan · Pull Request #136 · OneKeyHQ/firmware-classic1s

lihuanhuan · 2025-04-01T10:33:53Z

Summary by CodeRabbit

New Features
- Firmware builds now offer configurable options—including a dedicated bitcoin-only mode that adjusts firmware naming and available functionalities.
- Full-mode builds now feature an enhanced security menu option for FIDO keys, improving user authentication access.
- New message types for Solana and Benfen protocols have been introduced, expanding the functionality for off-chain message handling.
Chores
- The build process has been updated with a flexible configuration strategy and improved automation, including streamlined notifications and versioning for smoother release management.

coderabbitai · 2025-04-01T10:34:01Z

Walkthrough

This pull request updates the build workflow and firmware configuration to support multiple build configurations using a matrix. It adds new jobs and outputs for firmware building and Slack notifications. The changes implement conditional logic throughout the firmware source and Makefiles based on the BITCOIN_ONLY flag, affecting file naming, object file inclusion, and feature availability. Additionally, minor script modifications include commenting out certain build commands and updating the cpp invocation in the version script.

Changes

File(s)	Summary of Changes
`.github/workflows/build-classic1s.yml`	Updated build workflow: changed `runs-on` from `ubuntu-20.04` to `ubuntu-latest`, added a matrix strategy, new job "Build Classic1S", introduced multiple output variables, and added the `notify-slack` job for sending Slack notifications.
`legacy/firmware/Makefile`, `legacy/firmware/protob/Makefile`	Modified build configuration based on `BITCOIN_ONLY`: updated `NAME` with conditional assignments; adjusted object files inclusion in the Makefile; expanded `SKIPPED_MESSAGES` list with additional entries when `BITCOIN_ONLY` is set.
`legacy/firmware/menu_list.c`, `legacy/firmware/protect.c`, `legacy/firmware/usb.c`	Introduced conditional compilation blocks using `#if !BITCOIN_ONLY` to control inclusion of resident credential functionality, modify protectWaitKey logic, and conditionally compile USB U2F functions and I2C handling.
`legacy/script/cibuild`	Commented out the `make` commands for the `intermediate_fw` directory, thereby disabling the execution of these commands under certain conditions.
`tools/version.sh`	Updated the cpp invocation to use the full path `/usr/bin/cpp` instead of relying on the system PATH.

Sequence Diagram(s)

sequenceDiagram
    participant B as Build Job (build-classic1s)
    participant N as Notification Job (notify-slack)
    participant S as Slack API

    B->>N: Complete build with output variables
    N->>S: Send Slack notification with build details
    S-->>N: Acknowledge notification

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary or Summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 5

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4b3cbd7 and 4d8d2d8.

📒 Files selected for processing (8)

.github/workflows/build-classic1s.yml (3 hunks)
legacy/firmware/Makefile (2 hunks)
legacy/firmware/menu_list.c (3 hunks)
legacy/firmware/protect.c (1 hunks)
legacy/firmware/protob/Makefile (1 hunks)
legacy/firmware/usb.c (3 hunks)
legacy/script/cibuild (1 hunks)
tools/version.sh (1 hunks)

🧰 Additional context used

🧬 Code Definitions (3)

legacy/firmware/menu_list.c (2)

legacy/firmware/menu_para.c (2)

menu_para_passphrase (50-54)

menu_para_passphrase_index (108-112)

legacy/firmware/menu_para.h (2)

menu_para_passphrase (10-10)

menu_para_passphrase_index (20-20)

legacy/firmware/usb.c (3)

legacy/firmware/fido2/ctap_trans.c (3)

get_ble_fido_data_ptr (1312-1312)

set_ble_fido_data_len (1310-1310)

ctap_ble_cmd (1694-1733)

legacy/firmware/fido2/ctap_trans.h (3)

get_ble_fido_data_ptr (74-74)

set_ble_fido_data_len (75-75)

ctap_ble_cmd (72-72)

legacy/trans_fifo.c (1)

fifo_read_lock (66-82)

legacy/firmware/protect.c (2)

legacy/firmware/layout2.c (1)

layoutScreensaver (289-298)

legacy/firmware/layout2.h (1)

layoutScreensaver (57-57)

🪛 Shellcheck (0.10.0)

tools/version.sh

[info] 7-7: Double quote to prevent globbing and word splitting.

(SC2086)

🪛 actionlint (1.7.4)

.github/workflows/build-classic1s.yml

61-61: shellcheck reported issue in this script: SC2086:info:2:3: Double quote to prevent globbing and word splitting

(shellcheck)

🪛 YAMLlint (1.35.1)

.github/workflows/build-classic1s.yml

[error] 64-64: trailing spaces

(trailing-spaces)

[error] 67-67: trailing spaces

(trailing-spaces)

[error] 101-101: trailing spaces

(trailing-spaces)

[error] 103-103: trailing spaces

(trailing-spaces)

[error] 104-104: trailing spaces

(trailing-spaces)

[error] 105-105: trailing spaces

(trailing-spaces)

[error] 132-132: no new line character at the end of file

(new-line-at-end-of-file)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: Gen check
GitHub Check: Defs check

🔇 Additional comments (13)

legacy/firmware/protob/Makefile (1)

17-18: Correctly adds new cryptocurrencies to BITCOIN_ONLY skip list

This change properly extends the list of skipped messages for BITCOIN_ONLY mode to include Cardano, Scdo, Nostr, Tron, Ripple, and Lnurl. This ensures these non-Bitcoin cryptocurrencies are excluded when BITCOIN_ONLY=1.

legacy/firmware/Makefile (1)

10-14: Correct conditional naming for BITCOIN_ONLY builds

The firmware name now correctly indicates "bc-only" when BITCOIN_ONLY=1, making Bitcoin-only builds easily identifiable.

legacy/firmware/protect.c (1)

810-817: Correctly conditioned U2F functionality for non-Bitcoin builds

Added appropriate conditional compilation directive to exclude U2F handler code from Bitcoin-only builds. This ensures U2F functionality is only included when needed.

legacy/firmware/usb.c (2)

452-460: Appropriate conditional compilation for FIDO functionality

Good addition of #if !BITCOIN_ONLY conditional to exclude FIDO-specific code when building the Bitcoin-only version. This helps reduce binary size and remove unused functionality.

570-584: Proper conditional compilation of U2F data sending function

Wrapping the usb_u2f_data_send function in #if !BITCOIN_ONLY correctly excludes this function from Bitcoin-only builds where U2F functionality isn't needed.

🧰 Tools

🪛 Cppcheck (2.10-2)

[style] 571-571: The function 'usb_u2f_data_send' is never used.

(unusedFunction)

legacy/firmware/menu_list.c (3)

20-23: Good conditional inclusion of FIDO credentials

Properly wrapped the FIDO2 header inclusion and resident_credential_refresh variable in #if !BITCOIN_ONLY condition to exclude from Bitcoin-only builds.

374-505: Appropriate conditional compilation of FIDO2 resident credential functions

Correctly wrapped the entire FIDO2 resident credential implementation in #if !BITCOIN_ONLY conditional. This eliminates unnecessary code from Bitcoin-only firmware builds.

512-515: Proper conditional inclusion of FIDO menu item

Good job conditionally including the "FIDO Keys" menu item only when not in Bitcoin-only mode. This ensures the menu structure remains consistent with available functionality.

.github/workflows/build-classic1s.yml (5)

10-33: Well-structured build matrix setup

Good implementation of build matrix to generate different firmware variants (prod/qa and with/without Bitcoin-only support). The naming scheme with descriptive artifact suffixes will help distinguish the builds.

42-58: Improved variable population and outputs

Simplified firmware version extraction with awk and properly set up output variables that can be used by dependent jobs.

68-80: Good conditional build configuration

Well-structured conditional build configuration based on matrix values. The approach makes it clear which environment variables are set for each build type.

85-104: Well-implemented build artifact handling

Good conditional logic for handling different artifact types based on build configuration. The approach ensures correct file naming and hash generation.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 101-101: trailing spaces

(trailing-spaces)

[error] 103-103: trailing spaces

(trailing-spaces)

[error] 104-104: trailing spaces

(trailing-spaces)

112-131: Well-structured Slack notification job

Good addition of a notification job that reuses outputs from the build job. This keeps the notification logic separate from the build logic.

tools/version.sh

legacy/script/cibuild

legacy/firmware/Makefile

.github/workflows/build-classic1s.yml

coderabbitai

Actionable comments posted: 9

🔭 Outside diff range comments (1)

core/src/trezor/enums/__init__.py (1)

731-736: ⚠️ Potential issue

Move Ton-specific enums inside the BITCOIN_ONLY check

These Ton-specific enum classes should be conditionally included based on the BITCOIN_ONLY flag.

if TYPE_CHECKING:
-    class TonWalletVersion(IntEnum):
-        V4R2 = 3
-
-    class TonWorkChain(IntEnum):
-        BASECHAIN = 0
-        MASTERCHAIN = 1

Suggested implementation:

if TYPE_CHECKING:
    if not utils.BITCOIN_ONLY:
        class TonWalletVersion(IntEnum):
            V4R2 = 3

        class TonWorkChain(IntEnum):
            BASECHAIN = 0
            MASTERCHAIN = 1

♻️ Duplicate comments (3)

tools/version.sh (1)
7-7: 🧹 Nitpick (assertive)

Good change to use absolute path for cpp

Using the full path /usr/bin/cpp ensures consistent behavior across environments, eliminating potential PATH-related issues.

You should also add double quotes around the variable reference to prevent word splitting:
-echo "VERSION_MAJOR.VERSION_MINOR.VERSION_PATCH" | /usr/bin/cpp -include $1 -nostdinc -P | tr -d " "
+echo "VERSION_MAJOR.VERSION_MINOR.VERSION_PATCH" | /usr/bin/cpp -include "$1" -nostdinc -P | tr -d " "
🧰 Tools

🪛 Shellcheck (0.10.0)

[info] 7-7: Double quote to prevent globbing and word splitting.

(SC2086)
legacy/script/cibuild (1)
35-36: 🧹 Nitpick (assertive)

Add comment explaining why these steps are disabled

The intermediate firmware build steps have been commented out, but there's no explanation why. Add a brief comment to help future developers understand the reason.
-    # make -C intermediate_fw
-    # make -C intermediate_fw sign
+    # Disabled intermediate firmware build for BITCOIN_ONLY compatibility
+    # make -C intermediate_fw
+    # make -C intermediate_fw sign
legacy/firmware/Makefile (1)
90-91: ⚠️ Potential issue

Move Bitcoin-specific objects into conditional block

These Bitcoin-specific object files should be conditionally included based on BITCOIN_ONLY like other crypto-specific objects.

Apply this fix:
-OBJS += psbt/psbt.o
-OBJS += bip322_simple/bip322_simple.o
+ifdef BITCOIN_ONLY
+OBJS += psbt/psbt.o
+OBJS += bip322_simple/bip322_simple.o
+endif

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 4d8d2d8 and c2e1e2e.

📒 Files selected for processing (20)

.github/workflows/build-classic1s.yml (3 hunks)
core/src/all_modules.py (2 hunks)
core/src/apps/ethereum/networks.py (19 hunks)
core/src/trezor/enums/CardanoCertificateType.py (1 hunks)
core/src/trezor/enums/CardanoDRepType.py (1 hunks)
core/src/trezor/enums/CardanoTxAuxiliaryDataSupplementType.py (1 hunks)
core/src/trezor/enums/MessageType.py (2 hunks)
core/src/trezor/enums/SolanaOffChainMessageFormat.py (1 hunks)
core/src/trezor/enums/SolanaOffChainMessageVersion.py (1 hunks)
core/src/trezor/enums/__init__.py (5 hunks)
core/src/trezor/messages.py (16 hunks)
legacy/firmware/Makefile (2 hunks)
legacy/firmware/menu_list.c (3 hunks)
legacy/firmware/protect.c (1 hunks)
legacy/firmware/protob/Makefile (1 hunks)
legacy/firmware/usb.c (3 hunks)
legacy/script/cibuild (1 hunks)
python/src/trezorlib/cli/sol.py (1 hunks)
python/src/trezorlib/messages.py (21 hunks)
tools/version.sh (1 hunks)

🧰 Additional context used

🧬 Code Definitions (8)

legacy/firmware/menu_list.c (2)

legacy/firmware/menu_para.c (2)

menu_para_passphrase (50-54)

menu_para_passphrase_index (108-112)

legacy/firmware/menu_para.h (2)

menu_para_passphrase (10-10)

menu_para_passphrase_index (20-20)

legacy/firmware/protect.c (2)

legacy/firmware/layout2.c (1)

layoutScreensaver (289-298)

legacy/firmware/layout2.h (1)

layoutScreensaver (57-57)

legacy/firmware/usb.c (3)

legacy/firmware/fido2/ctap_trans.c (3)

get_ble_fido_data_ptr (1312-1312)

set_ble_fido_data_len (1310-1310)

ctap_ble_cmd (1694-1733)

legacy/firmware/fido2/ctap_trans.h (3)

get_ble_fido_data_ptr (74-74)

set_ble_fido_data_len (75-75)

ctap_ble_cmd (72-72)

legacy/trans_fifo.c (1)

fifo_read_lock (66-82)

core/src/all_modules.py (2)

core/src/trezor/enums/__init__.py (7)

SolanaOffChainMessageFormat (701-703)

SolanaOffChainMessageVersion (698-699)

TonWalletVersion (731-732)

TonWorkChain (734-736)

CardanoCVoteRegistrationFormat (562-564)

CardanoCertificateType (538-545)

CardanoDRepType (547-551)

python/src/trezorlib/messages.py (7)

SolanaOffChainMessageFormat (751-753)

SolanaOffChainMessageVersion (747-748)

TonWalletVersion (787-788)

TonWorkChain (791-793)

CardanoCVoteRegistrationFormat (588-590)

CardanoCertificateType (560-567)

CardanoDRepType (570-574)

core/src/trezor/enums/MessageType.py (1)

core/src/trezor/messages.py (15)

SolanaSignOffChainMessage (7442-7462)

SolanaMessageSignature (7480-7494)

SolanaSignUnsafeMessage (7464-7478)

BenfenGetAddress (420-434)

BenfenAddress (436-448)

BenfenSignTx (450-470)

BenfenSignedTx (472-486)

BenfenSignMessage (520-534)

BenfenMessageSignature (536-550)

BenfenTxRequest (488-504)

BenfenTxAck (506-518)

NeoGetAddress (6674-6688)

NeoAddress (6690-6704)

NeoSignTx (6706-6722)

NeoSignedTx (6724-6738)

core/src/trezor/enums/__init__.py (1)

core/src/trezor/messages.py (15)

SolanaSignOffChainMessage (7442-7462)

SolanaMessageSignature (7480-7494)

SolanaSignUnsafeMessage (7464-7478)

BenfenGetAddress (420-434)

BenfenAddress (436-448)

BenfenSignTx (450-470)

BenfenSignedTx (472-486)

BenfenSignMessage (520-534)

BenfenMessageSignature (536-550)

BenfenTxRequest (488-504)

BenfenTxAck (506-518)

NeoGetAddress (6674-6688)

NeoAddress (6690-6704)

NeoSignTx (6706-6722)

NeoSignedTx (6724-6738)

python/src/trezorlib/messages.py (2)

core/src/trezor/messages.py (12)

SolanaSignOffChainMessage (7442-7462)

SolanaMessageSignature (7480-7494)

SolanaSignUnsafeMessage (7464-7478)

BenfenGetAddress (420-434)

BenfenAddress (436-448)

BenfenSignTx (450-470)

BenfenSignedTx (472-486)

BenfenSignMessage (520-534)

BenfenMessageSignature (536-550)

BenfenTxRequest (488-504)

BenfenTxAck (506-518)

CardanoDRep (2126-2142)

core/src/trezor/enums/__init__.py (5)

CardanoDRepType (547-551)

CardanoCVoteRegistrationFormat (562-564)

SolanaOffChainMessageVersion (698-699)

SolanaOffChainMessageFormat (701-703)

MessageType (23-415)

core/src/trezor/messages.py (2)

python/src/trezorlib/messages.py (14)

CardanoCVoteRegistrationFormat (588-590)

CardanoCertificateType (560-567)

CardanoDRepType (570-574)

SolanaOffChainMessageFormat (751-753)

SolanaOffChainMessageVersion (747-748)

BenfenGetAddress (1173-1187)

MessageType (31-423)

BenfenSignTx (1204-1227)

BenfenSignedTx (1230-1244)

CardanoDRep (3393-3410)

CardanoTxCertificate (3413-3445)

CardanoCVoteRegistrationDelegation (3471-3485)

CardanoCVoteRegistrationParametersType (3488-3520)

CardanoTxAuxiliaryData (3523-3537)

core/src/trezor/enums/__init__.py (6)

CardanoCVoteRegistrationFormat (562-564)

CardanoCertificateType (538-545)

CardanoDRepType (547-551)

SolanaOffChainMessageFormat (701-703)

SolanaOffChainMessageVersion (698-699)

MessageType (23-415)

🪛 Shellcheck (0.10.0)

tools/version.sh

[info] 7-7: Double quote to prevent globbing and word splitting.

(SC2086)

🪛 actionlint (1.7.4)

.github/workflows/build-classic1s.yml

61-61: shellcheck reported issue in this script: SC2086:info:2:3: Double quote to prevent globbing and word splitting

(shellcheck)

🪛 Ruff (0.8.2)

python/src/trezorlib/messages.py

1175-1178: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

1186-1186: Remove quotes from type annotation

Remove quotes

(UP037)

1192-1194: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

1206-1212: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

1223-1223: Remove quotes from type annotation

Remove quotes

(UP037)

1232-1235: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

1249-1253: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

1269-1271: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

1283-1286: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

1294-1294: Remove quotes from type annotation

Remove quotes

(UP037)

1300-1303: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

3395-3399: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

3438-3438: Remove quotes from type annotation

Remove quotes

(UP037)

3473-3476: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

3490-3499: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

3513-3513: Remove quotes from type annotation

Remove quotes

(UP037)

3514-3514: Remove quotes from type annotation

Remove quotes

(UP037)

3525-3528: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

3707-3707: Remove quotes from type annotation

Remove quotes

(UP037)

8485-8488: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

8496-8496: Remove quotes from type annotation

Remove quotes

(UP037)

8502-8505: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

8519-8523: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

8532-8532: Remove quotes from type annotation

Remove quotes

(UP037)

8539-8542: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

9315-9321: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

9332-9332: Remove quotes from type annotation

Remove quotes

(UP037)

9341-9344: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

9352-9352: Remove quotes from type annotation

Remove quotes

(UP037)

9358-9361: Mutable class attributes should be annotated with typing.ClassVar

(RUF012)

core/src/trezor/messages.py

27-27: Unused noqa directive (unused: F401)