Skip to content

chore: optimize ton version limit #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 13, 2025
Merged

Conversation

ByteZhang1024
Copy link
Contributor

@ByteZhang1024 ByteZhang1024 commented May 9, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced device compatibility checks for TON address retrieval, message signing, and proof features.
    • Added a new Bitcoin transaction signing example featuring a large number of reference transaction outputs.
  • Refactor
    • Updated device model naming for version requirements to improve clarity in device support messages.
  • Bug Fixes
    • Activated previously commented reference transaction outputs and added lock time in Bitcoin transaction signing example.

Copy link
Contributor

coderabbitai bot commented May 9, 2025

Walkthrough

The changes add a strictCheckDeviceSupport property set to true in three TON-related classes. They also update the device model key from pro to model_touch in the getVersionRange() method. Some unused imports were removed. No other logic or flow was changed. Additionally, a Bitcoin example was updated to include a large reference transaction with many outputs and a new example was added.

Changes

Files Change Summary
packages/core/src/api/ton/TonGetAddress.ts
packages/core/src/api/ton/TonSignMessage.ts
packages/core/src/api/ton/TonSignProof.ts
Added strictCheckDeviceSupport = true in init() methods. Changed getVersionRange() to use model_touch instead of pro for device versioning.
packages/core/src/api/ton/TonSignMessage.ts Removed unused imports related to hardware error handling from @onekeyfe/hd-shared.
packages/connect-examples/expo-example/src/data/bitcoin.ts Uncommented bin_outputs and added lock_time in existing Bitcoin transaction example. Added new example with 80,000 reference transaction outputs.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TonClass (GetAddress/SignMessage/SignProof)
    participant Device

    User->>TonClass: Initialize
    TonClass->>TonClass: Set strictCheckDeviceSupport = true
    TonClass->>Device: Check device model and version (model_touch >= 4.10.0)
    Device-->>TonClass: Respond with support status
    TonClass-->>User: Proceed or error based on support
Loading

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@ByteZhang1024 ByteZhang1024 force-pushed the chore/optimizeTonVersion branch from a96c0a5 to 8c040bd Compare May 13, 2025 03:48
@ByteZhang1024 ByteZhang1024 enabled auto-merge (squash) May 13, 2025 03:48
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
packages/connect-examples/expo-example/src/data/bitcoin.ts (1)

290-342: 🧹 Nitpick (assertive)

Large transaction test case is valuable but consider performance

This new example with 80,000 outputs helps test edge cases with large transactions, which is good practice. However, creating such a massive array in memory might slow down the demo app.

Consider these improvements:

  1. Reduce the number of outputs to 1,000-5,000 for better demo performance
  2. Translate the Chinese comment "P2PKH 脚本" to English for consistency
  3. Add a brief comment explaining why testing with large transactions matters
- ...Array.from({ length: 80_000 }, (_, i) => ({
+ ...Array.from({ length: 5_000 }, (_, i) => ({
  amount: '100000000',
-  script_pubkey: `76a914${i.toString(16).padStart(40, '0')}88ac`, // P2PKH 脚本
+  script_pubkey: `76a914${i.toString(16).padStart(40, '0')}88ac`, // P2PKH script - testing firmware with large transactions
})),
📜 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 a96c0a5 and 8c040bd.

📒 Files selected for processing (4)
  • packages/connect-examples/expo-example/src/data/bitcoin.ts (1 hunks)
  • packages/core/src/api/ton/TonGetAddress.ts (2 hunks)
  • packages/core/src/api/ton/TonSignMessage.ts (2 hunks)
  • packages/core/src/api/ton/TonSignProof.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build (18.x)
  • GitHub Check: lint (18.x)
🔇 Additional comments (6)
packages/connect-examples/expo-example/src/data/bitcoin.ts (1)

276-284: Good addition to the example

Adding bin_outputs and lock_time makes this Bitcoin transaction example more complete and realistic.

packages/core/src/api/ton/TonSignProof.ts (2)

11-11: Added strict device support check.

This adds stronger validation for device compatibility, matching the other TON classes.


46-46: Updated model key from 'pro' to 'model_touch'.

Consistent change across TON files for better device type identification.

packages/core/src/api/ton/TonGetAddress.ts (2)

15-15: Added strict device support check.

This adds stronger validation for device compatibility, matching the other TON classes.


60-60: Updated model key from 'pro' to 'model_touch'.

Consistent change across TON files for better device type identification.

packages/core/src/api/ton/TonSignMessage.ts (1)

23-23: Added strict device support check.

This adds stronger validation for device compatibility, matching the other TON classes.

@wabicai wabicai self-requested a review May 13, 2025 03:55
@ByteZhang1024 ByteZhang1024 merged commit 2015fb7 into onekey May 13, 2025
10 checks passed
@ByteZhang1024 ByteZhang1024 deleted the chore/optimizeTonVersion branch May 13, 2025 03:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants